Nuxt/.website
renovate[bot] 2f065184d2
chore(deps): pin devdependency @nuxt-themes/docus to 1.14.6 (main) (#22473)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-08-04 08:07:38 +01:00
..
.gitignore docs: add temporary website for docs contribution (#22469) 2023-08-03 14:44:10 +01:00
README.md docs: add temporary website for docs contribution (#22469) 2023-08-03 14:44:10 +01:00
app.config.ts docs: add temporary website for docs contribution (#22469) 2023-08-03 14:44:10 +01:00
nuxt.config.ts docs: add temporary website for docs contribution (#22469) 2023-08-03 14:44:10 +01:00
package.json chore(deps): pin devdependency @nuxt-themes/docus to 1.14.6 (main) (#22473) 2023-08-04 08:07:38 +01:00
tsconfig.json docs: add temporary website for docs contribution (#22469) 2023-08-03 14:44:10 +01:00

README.md

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:

pnpm i

Then stub the dependencies:

pnpm build:stub

Development

In the root of the nuxt folder, run:

pnpm docs:dev

Then open 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.