mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-11 00:23:53 +00:00
docs: add temporary website for docs contribution (#22469)
This commit is contained in:
parent
caf8329151
commit
c11585e713
12
.website/.gitignore
vendored
Executable file
12
.website/.gitignore
vendored
Executable file
@ -0,0 +1,12 @@
|
|||||||
|
node_modules
|
||||||
|
*.iml
|
||||||
|
.idea
|
||||||
|
*.log*
|
||||||
|
.nuxt
|
||||||
|
.vscode
|
||||||
|
.DS_Store
|
||||||
|
coverage
|
||||||
|
dist
|
||||||
|
sw.*
|
||||||
|
.env
|
||||||
|
.output
|
35
.website/README.md
Executable file
35
.website/README.md
Executable file
@ -0,0 +1,35 @@
|
|||||||
|
# Nuxt Docs Website
|
||||||
|
|
||||||
|
This is a temporary directory until we open source the repository for nuxt.com.
|
||||||
|
|
||||||
|
The goal is to simplify the contribution in the meantine to the documentation by having the possibility to preview the changes locally.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
Install dependencies in the root of the `nuxt` folder:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm i
|
||||||
|
```
|
||||||
|
|
||||||
|
Then stub the dependencies:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm build:stub
|
||||||
|
```
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
In the root of the `nuxt` folder, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm docs:dev
|
||||||
|
```
|
||||||
|
|
||||||
|
Then open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||||
|
|
||||||
|
Update the documentation within the `docs` folder.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
For a detailed explanation of how things work, check out [Docus](https://docus.dev).
|
14
.website/app.config.ts
Normal file
14
.website/app.config.ts
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
export default defineAppConfig({
|
||||||
|
docus: {
|
||||||
|
title: 'Nuxt Docs [dev]',
|
||||||
|
description: 'The best place to start your documentation.',
|
||||||
|
socials: {
|
||||||
|
twitter: 'nuxt_js',
|
||||||
|
github: 'nuxt/nuxt'
|
||||||
|
},
|
||||||
|
aside: {
|
||||||
|
level: 1,
|
||||||
|
collapsed: false,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
})
|
20
.website/nuxt.config.ts
Executable file
20
.website/nuxt.config.ts
Executable file
@ -0,0 +1,20 @@
|
|||||||
|
import { createResolver } from 'nuxt/kit'
|
||||||
|
|
||||||
|
const { resolve } = createResolver(import.meta.url)
|
||||||
|
|
||||||
|
export default defineNuxtConfig({
|
||||||
|
// https://github.com/nuxt-themes/docus
|
||||||
|
extends: '@nuxt-themes/docus',
|
||||||
|
content: {
|
||||||
|
sources: {
|
||||||
|
docs: {
|
||||||
|
driver: 'fs',
|
||||||
|
prefix: '/',
|
||||||
|
base: resolve('../docs')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
experimental: {
|
||||||
|
renderJsonPayloads: false
|
||||||
|
}
|
||||||
|
})
|
14
.website/package.json
Executable file
14
.website/package.json
Executable file
@ -0,0 +1,14 @@
|
|||||||
|
{
|
||||||
|
"name": "docus-starter",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"private": true,
|
||||||
|
"scripts": {
|
||||||
|
"dev": "nuxt dev",
|
||||||
|
"build": "nuxt build",
|
||||||
|
"generate": "nuxt generate",
|
||||||
|
"preview": "nuxt preview"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@nuxt-themes/docus": "^1.14.6"
|
||||||
|
}
|
||||||
|
}
|
3
.website/tsconfig.json
Executable file
3
.website/tsconfig.json
Executable file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"extends": "./.nuxt/tsconfig.json"
|
||||||
|
}
|
@ -14,6 +14,7 @@
|
|||||||
"lint:docs": "markdownlint ./docs && case-police 'docs/**/*.md' *.md",
|
"lint:docs": "markdownlint ./docs && case-police 'docs/**/*.md' *.md",
|
||||||
"lint:docs:fix": "markdownlint ./docs --fix && case-police 'docs/**/*.md' *.md --fix",
|
"lint:docs:fix": "markdownlint ./docs --fix && case-police 'docs/**/*.md' *.md --fix",
|
||||||
"lint:knip": "pnpx knip",
|
"lint:knip": "pnpx knip",
|
||||||
|
"docs:dev": "nuxi dev .website",
|
||||||
"play": "nuxi dev playground",
|
"play": "nuxi dev playground",
|
||||||
"play:build": "nuxi build playground",
|
"play:build": "nuxi build playground",
|
||||||
"play:preview": "nuxi preview playground",
|
"play:preview": "nuxi preview playground",
|
||||||
|
1963
pnpm-lock.yaml
1963
pnpm-lock.yaml
File diff suppressed because it is too large
Load Diff
@ -2,3 +2,4 @@ packages:
|
|||||||
- "packages/**"
|
- "packages/**"
|
||||||
- "playground"
|
- "playground"
|
||||||
- "test/fixtures/*"
|
- "test/fixtures/*"
|
||||||
|
- ".website"
|
||||||
|
Loading…
Reference in New Issue
Block a user