Writing Docs

When developing your docs locally, you can use the Doctave CLI's serve command to preview the rendered documentation.

$ doctave serve
Doctave | Serve
Starting development server...

Server running on http://0.0.0.0:4001/

You can now visit localhost:4001 to see your docs rendered.

Whenever you make a change, the site will get regenerated, and your browser will automatically refresh.

Server running on http://0.0.0.0:4001/

    File ./docs/writing_docs/README.md updated.
    Site rebuilt in 26.752934ms

Features

You can read more about Doctave's more advanced features here: