Skip to content

Commit 766e7c2

Browse files
committed
chore: add docs files
0 parents  commit 766e7c2

22 files changed

+930
-0
lines changed

.eslintignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
dist
2+
node_modules
3+
.output
4+
.nuxt

.eslintrc.cjs

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
module.exports = {
2+
root: true,
3+
extends: '@nuxt/eslint-config',
4+
rules: {
5+
'vue/max-attributes-per-line': 'off',
6+
'vue/multi-word-component-names': 'off'
7+
}
8+
}

.gitignore

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
node_modules
2+
*.iml
3+
.idea
4+
*.log*
5+
.nuxt
6+
.vscode
7+
.DS_Store
8+
coverage
9+
dist
10+
sw.*
11+
.env
12+
.output
13+
package-lock.json

.npmrc

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
shamefully-hoist=true
2+
strict-peer-dependencies=false

README.md

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Docus Starter
2+
3+
Starter template for [Docus](https://docus.dev).
4+
5+
## Clone
6+
7+
Clone the repository (using `nuxi`):
8+
9+
```bash
10+
npx nuxi init -t themes/docus
11+
```
12+
13+
## Setup
14+
15+
Install dependencies:
16+
17+
```bash
18+
yarn install
19+
```
20+
21+
## Development
22+
23+
```bash
24+
yarn dev
25+
```
26+
27+
## Edge Side Rendering
28+
29+
Can be deployed to Vercel Functions, Netlify Functions, AWS, and most Node-compatible environments.
30+
31+
Look at all the available presets [here](https://v3.nuxtjs.org/guide/deploy/presets).
32+
33+
```bash
34+
yarn build
35+
```
36+
37+
## Static Generation
38+
39+
Use the `generate` command to build your application.
40+
41+
The HTML files will be generated in the .output/public directory and ready to be deployed to any static compatible hosting.
42+
43+
```bash
44+
yarn generate
45+
```
46+
47+
## Preview build
48+
49+
You might want to preview the result of your build locally, to do so, run the following command:
50+
51+
```bash
52+
yarn preview
53+
```
54+
55+
---
56+
57+
For a detailed explanation of how things work, check out [Docus](https://docus.dev).

app.config.ts

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
export default defineAppConfig({
2+
docus: {
3+
title: 'Automata',
4+
description: 'Harmonize the rythm of sound.',
5+
socials: {
6+
twitter: 'scr3ppie',
7+
github: 'shadowrunners/automata'
8+
},
9+
github: {
10+
branch: 'docs',
11+
repo: 'automata',
12+
owner: 'shadowrunners',
13+
edit: true
14+
},
15+
aside: {
16+
level: 0,
17+
collapsed: false,
18+
exclude: []
19+
},
20+
main: {
21+
padded: true,
22+
fluid: true
23+
},
24+
header: {
25+
logo: true,
26+
showLinkIcon: true,
27+
exclude: [],
28+
fluid: true
29+
},
30+
footer: {
31+
iconLinks: [
32+
{
33+
href: 'https://nuxt.com',
34+
icon: 'simple-icons:nuxtdotjs'
35+
}
36+
]
37+
}
38+
}
39+
})

content/0.index.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: Home
3+
navigation: false
4+
layout: page
5+
main:
6+
fluid: false
7+
---
8+
9+
:ellipsis{right=0px width=75% blur=150px}
10+
11+
::block-hero
12+
---
13+
cta:
14+
- Jump in
15+
- /introduction/getting-started
16+
secondary:
17+
- Open on GitHub →
18+
- https://github.com/shadowrunners/Automata
19+
---
20+
21+
#title
22+
Harmonize the rythm of sound.
23+
24+
#description
25+
Unlock the melodic universe, DMCA-free. Discover the Power of Automata: Seamless Streaming from Deezer, Spotify, SoundCloud, and Beyond.
26+
27+
#extra
28+
::list
29+
- **Entirely** YouTube / YouTube Music free (does not have native support for these platforms)
30+
- **Deezer** powered via [LavaSrc](https://github.com/TopiSenpai/LavaSrc)
31+
- **Large platform support** from SoundCloud to Spotify to a whole lot more!
32+
::
33+
34+
#support
35+
::terminal
36+
---
37+
content:
38+
- npm i @shadowrunners/automata
39+
---
40+
::
41+
::
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Mffffffffffff
2+
3+
::code-group
4+
```
5+
new Automata.Manager(options: AutomataOptions)
6+
```
7+
::
8+
9+
## Play online
10+
11+
You can start playing with Docus in your browser using Stackblitz:
12+
13+
:button-link[Play on StackBlitz]{size="small" icon="IconStackBlitz" href="https://stackblitz.com/github/nuxt-themes/docus-starter" blank}
14+
15+
## Create a new project
16+
17+
1. Start a fresh Docus project with:
18+
19+
```bash [npx]
20+
npx nuxi@latest init docs -t themes/docus
21+
```
22+
23+
2. Install the dependencies in the `docs` folder:
24+
25+
::code-group
26+
27+
```bash [npm]
28+
npm install
29+
```
30+
31+
```bash [yarn]
32+
yarn install
33+
```
34+
35+
```bash [pnpm]
36+
pnpm install --shamefully-hoist
37+
```
38+
39+
::
40+
41+
3. Run the `dev` command to start Docus in development mode:
42+
43+
::code-group
44+
45+
```bash [npm]
46+
npm run dev
47+
```
48+
49+
```bash [yarn]
50+
yarn dev
51+
```
52+
53+
```bash [pnpm]
54+
pnpm run dev
55+
```
56+
57+
::
58+
59+
::alert{type="success"}
60+
✨ Well done! A browser window should automatically open for <http://localhost:3000>
61+
::
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Project Structure
2+
3+
Docus is a Nuxt theme that provides a ready-to-use documentation website, if you are familiar with Nuxt, you will feel right at home.
4+
5+
## Directory Structure
6+
7+
This is the minimal directory structure to get an up and running Docus website.
8+
9+
```bash
10+
content/
11+
index.md
12+
app.config.ts
13+
nuxt.config.ts
14+
```
15+
16+
The `content/` directory is where you [write Markdown pages](/introduction/writing-pages).
17+
18+
The `app.config.ts` is where you [configure Docus](/introduction/configuration) to fit your branding and design.
19+
20+
21+
The `nuxt.config.ts` is your [Nuxt configuration](https://nuxt.com/docs/getting-started/configuration).
+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Writing Pages
2+
3+
Docus is made to let you write all your content in Markdown and Vue components with the MDC syntax.
4+
5+
Each Markdown pages in the `content/` folder will be mapped to a route.
6+
7+
| File | Generated route |
8+
| ------------------------ | :-------------------- |
9+
| `index.md` | `/` |
10+
| `about.md` | `/about` |
11+
| `blog/index.md` | `/blog` |
12+
| `blog/hello.md` | `/blog/hello` |
13+
| `1.guide/2.installation` | `/guide/installation` |
14+
15+
## Frontmatter
16+
17+
Docus supports multiple Front-matter attributes for pages.
18+
19+
```md [index.md]
20+
---
21+
title: "Get Started"
22+
description: "Let's learn how to use my amazing module."
23+
---
24+
```
25+
26+
| **Key** | **Type** | **Default** | **Description** |
27+
| ----------------------- | --------- | ----------- | ------------------------------------------------------------- |
28+
| `layout` | `string` | `default` | Use any layout name like you would in `definePageMeta()` |
29+
| `title` | `string` | | Defines the page title and H1 in docs pages |
30+
| `description` | `string` | | Defines the page description and excerpt in docs pages |
31+
| `redirect` | `string` | | A route path to redirect |
32+
| `image` | `object` | | OpenGraph cover image |
33+
| **Docs layout options** | | | |
34+
| `aside` | `boolean` | | Toggles the visibility of aside navigation |
35+
| `toc` | `boolean` | | Toggles the visibility of table of contents |
36+
| `header` | `boolean` | | Toggles the visibility of the page header |
37+
| `bottom` | `boolean` | | Toggles the visibility of page bottom section |
38+
| **Navigation options** | | | |
39+
| `navigation` | `boolean` | | Toggles the visibility of the page or directory in navigation |
40+
| `navigation.title` | `string` | | Changes the name of the page or directory in navigation |
41+
| `navigation.icon` | `string` | | Changes the icon of the page or directory in navigation |

content/1.introduction/_dir.yml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
icon: ph:star-duotone
2+
navigation.redirect: /introduction/getting-started

0 commit comments

Comments
 (0)