Skip to content

Commit a2dba3b

Browse files
GugustinetteGugustinette
authored
chore(app): initial commit by Nuxt Studio
1 parent a6cb11e commit a2dba3b

23 files changed

+1363
-0
lines changed

‎docs/.eslintignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
dist
2+
node_modules
3+
.output
4+
.nuxt

‎docs/.eslintrc.cjs‎

Lines changed: 8 additions & 0 deletions
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+
}

‎docs/.gitignore‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
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

‎docs/.npmrc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
shamefully-hoist=true
2+
strict-peer-dependencies=false

‎docs/README.md‎

Lines changed: 57 additions & 0 deletions
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).

‎docs/app.config.ts‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
export default defineAppConfig({
2+
docus: {
3+
title: 'Docus',
4+
description: 'The best place to start your documentation.',
5+
image: 'https://user-images.githubusercontent.com/904724/185365452-87b7ca7b-6030-4813-a2db-5e65c785bf88.png',
6+
socials: {
7+
twitter: 'nuxt_js',
8+
github: 'nuxt-themes/docus',
9+
nuxt: {
10+
label: 'Nuxt',
11+
icon: 'simple-icons:nuxtdotjs',
12+
href: 'https://nuxt.com'
13+
}
14+
},
15+
github: {
16+
dir: '.starters/default/content',
17+
branch: 'main',
18+
repo: 'docus',
19+
owner: 'nuxt-themes',
20+
edit: true
21+
},
22+
aside: {
23+
level: 0,
24+
collapsed: false,
25+
exclude: []
26+
},
27+
main: {
28+
padded: true,
29+
fluid: true
30+
},
31+
header: {
32+
logo: true,
33+
showLinkIcon: true,
34+
exclude: [],
35+
fluid: true
36+
}
37+
}
38+
})

‎docs/content/0.index.md‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
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+
- Get started
15+
- /introduction/getting-started
16+
secondary:
17+
- Open on GitHub →
18+
- https://github.com/nuxt-themes/docus
19+
---
20+
21+
#title
22+
The best place to start your documentation.
23+
24+
#description
25+
Write pages in [Markdown](https://content.nuxtjs.org), use [Vue](https://vuejs.org) components and enjoy the power of [Nuxt](https://nuxt.com).
26+
27+
#extra
28+
::list
29+
- **+50 Components** ready to build rich pages
30+
- **Docs** and **Page** layouts
31+
- Start from a `README`, scale to a framework documentation
32+
- Navigation and Table of Contents generation
33+
- Fully configurable design system
34+
- Leverages [**Typography**](https://typography.nuxt.space/) and [**Elements**](https://elements.nuxt.dev)
35+
- Used on [Content Documentation](https://content.nuxtjs.org)
36+
::
37+
38+
#support
39+
::terminal
40+
---
41+
content:
42+
- npx nuxi@latest init -t themes/docus
43+
- cd docs
44+
- npm install
45+
- npm run dev
46+
---
47+
::
48+
::
49+
50+
::card-grid
51+
#title
52+
What's included
53+
54+
#root
55+
:ellipsis{left=0px width=40rem top=10rem blur=140px}
56+
57+
#default
58+
::card{icon=logos:nuxt-icon}
59+
#title
60+
Nuxt Architecture
61+
#description
62+
Harness the full power of [Nuxt 3](https://v3.nuxtjs.org) and its [modules](https://modules.nuxtjs.org) ecosystem.
63+
::
64+
65+
::card{icon=IconNuxtStudio}
66+
#title
67+
Nuxt Studio ready
68+
#description
69+
Edit your theme content and appearance with live-preview within [Nuxt Studio](https://nuxt.studio).
70+
::
71+
72+
::card{icon=logos:vue}
73+
#title
74+
Vue Components
75+
#description
76+
Use built-in components (or your own!) inside your content.
77+
::
78+
79+
::card{icon=simple-icons:markdown}
80+
#title
81+
Write Markdown
82+
#description
83+
Enjoy the ease and simplicity of Markdown and discover [MDC syntax](https://content.nuxtjs.org/guide/writing/mdc).
84+
::
85+
86+
::card{icon=noto:rocket}
87+
#title
88+
Deploy anywhere
89+
#description
90+
Zero config on [Vercel](https://vercel.com) or [Netlify](https://netlify.com). Choose between static generation, on-demand rendering (Node) or edge-side rendering on [CloudFlare workers](https://workers.cloudflare.com).
91+
::
92+
93+
::card{icon=noto:puzzle-piece}
94+
#title
95+
Extensible.
96+
#description
97+
Customize the whole design, or add components using slots - you can make Docus your own.
98+
::
99+
::

‎docs/content/1.introduction/1.getting-started.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Getting Started
2+
3+
From your Markdown files to a deployed website in few minutes.
4+
5+
## Play online
6+
7+
You can start playing with Docus in your browser using Stackblitz:
8+
9+
:button-link[Play on StackBlitz]{size="small" icon="IconStackBlitz" href="https://stackblitz.com/github/nuxt-themes/docus-starter" blank}
10+
11+
## Create a new project
12+
13+
1. Start a fresh Docus project with:
14+
15+
```bash [npx]
16+
npx nuxi@latest init docs -t themes/docus
17+
```
18+
19+
2. Install the dependencies in the `docs` folder:
20+
21+
::code-group
22+
23+
```bash [npm]
24+
npm install
25+
```
26+
27+
```bash [yarn]
28+
yarn install
29+
```
30+
31+
```bash [pnpm]
32+
pnpm install --shamefully-hoist
33+
```
34+
35+
::
36+
37+
3. Run the `dev` command to start Docus in development mode:
38+
39+
::code-group
40+
41+
```bash [npm]
42+
npm run dev
43+
```
44+
45+
```bash [yarn]
46+
yarn dev
47+
```
48+
49+
```bash [pnpm]
50+
pnpm run dev
51+
```
52+
53+
::
54+
55+
::alert{type="success"}
56+
✨ Well done! A browser window should automatically open for <http://localhost:3000>
57+
::

‎docs/content/1.introduction/2.project-structure.md‎

Lines changed: 21 additions & 0 deletions
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).

‎docs/content/1.introduction/3.writing-pages.md‎

Lines changed: 41 additions & 0 deletions
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 |

0 commit comments

Comments
 (0)