2.3 KiB
title, description, navigation, seo
| title | description | navigation | seo | ||||
|---|---|---|---|---|---|---|---|
| Installation | Get started with Docus. |
|
|
Local development
::steps
Create your docs directory
Use the docus CLI to create a new Docus project in the docs/ directory:
npx docus init docs
We recommend using the npm package manager.
Start your docs server in development
Move to the docs/ directory and start your docs server in development mode:
npm run dev
A local preview of your documentation will be available at http://localhost:4000
Write your documentation
Head over the Edition section to learn how to write your documentation. ::
Online Edition with Nuxt Studio
::prose-steps
Create a new project on Nuxt Studio
Choose Start from a template and select Docus. Clone it on your GitHub personal account or any organisation of your choice.
Deploy in one click
Once your project has been created and you're in the project dashboard, navigate to the Deploy section, choose the GitHub Pages tab and set your Nuxt UI Pro license (NUXT_UI_PRO_LICENSE ) in the environment variables then click on the Deploy button.
:::prose-note
to: https://content.nuxt.com/docs/studio/setup#enable-the-full-editing-experience
This is a one click static deployment available with GitHub Pages but you can also handle deployment yourself and use the Selfhosted tab.
:::
Write your documentation in the editor
Once the deployment is achieved, you'll be able to display the preview of your documentation. You can browse your content pages to edit them or create new ones.
:video{controls loop poster="https://res.cloudinary.com/nuxt/video/upload/v1747230893/studio/wzt9zfmdvk7hgmdx3cnt.jpg" src="https://res.cloudinary.com/nuxt/video/upload/v1747230893/studio/wzt9zfmdvk7hgmdx3cnt.mp4"} ::
::prose-tip{to="https://content.nuxt.com/docs/studio/debug"} If you want to try Docus and Nuxt Studio in develoment mode without an UI Pro license, you can check the Nuxt Content documentation for local setup with Nuxt Studio. ::