Setting up beautiful documentation with Docus is one command away 🤙
Docus is a pre-configured Nuxt application, with Windi CSS and Nuxt Content.
- Node.js 12 or later
- MacOS, Windows, and Linux are supported
Start your documentation in a new GitHub repository by using our GitHub template:
::button-link{size="medium" blank href="https://github.com/nuxtlabs/docus-starter/generate"} Create a repo with the Docus starter ::
You can download the starter locally using degit. This allows you to add documentation to your existing repository.
npx degit nuxtlabs/docus-starter#main docs
This command will create a new folder named docs/ and download the Docus starter inside.
Vercel lets you set up the starter on your favorite Git provider (GitHub, GitLab or Bitbucket) - and deploy for free.
::button-link{blank href="https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Fnuxtlabs%2Fdocus-starter"} Create and deploy using Vercel ::
See it in action:
::video-player{loop playsinline controls} sources:
- src: https://res.cloudinary.com/nuxt/video/upload/q_auto/v1612886404/docus/docus-vercel_wwaryz.webm type: video/webm
- src: https://res.cloudinary.com/nuxt/video/upload/q_auto/v1612886404/docus/docus-vercel_wwaryz.mp4 type: video/mp4
- src: https//res.cloudinary.com/nuxt/video/upload/q_auto/v1612886404/docus/docus-vercel_wwaryz.ogv type: video/ogg poster: https://res.cloudinary.com/nuxt/video/upload/v1612886404/docus/docus-vercel_wwaryz.jpg
::
The directory structure of a minimal Docus project is the following:
| content/
---| index.md
---| settings.json
| static/
---| icon.png
---| preview.png
| nuxt.config.js
| package.json- Configure Docus with content/settings.json
- Write your documentation within content/{locale}
- Use our included components
- Manage your images and assets in static/
Start docus in development mode:
yarn devThe development server will listen on http://localhost:4000
Checkout the Deployment section when you are ready to publish your documentation.