This guide will show you how to get up and running with your documentation locally. Afterwards, you can visit the upload guide to see how to push your documentation to Doctave.com.
Create a project in Doctave
First, on your dashboard, click the
New Project button to create a new project.
Installing the CLI
First we need to install the Doctave CLI. This is a static documentation site generator that you can use to preview your documentation locally. It can also be used without Doctave.com as a standalone documentation generator.
You can install the CLI via Homebrew:
$ brew install doctave/doctave/doctave
Instructions for installing on Linux and Windows can be found here.
Initialize your documentation
Next, initialize your project. This will create the necessary files and folders.
$ doctave init Doctave | Init Creating your docs... Created doctave.yaml... Created docs folder... Created docs/README.md... Created docs/examples.md... Done! Run doctave serve to view your docs site locally.
This will create the documentation project structure.
$ tree . . ├── docs │ ├── examples.md │ └── README.md └── doctave.yaml 1 directory, 3 files
You can now run
doctave serve to preview your documentation. Any changes you make in the files
docs/ will be reflected immediately in your browser.
$ doctave serve Doctave | Serve Starting development server... Server running on http://0.0.0.0:4001/
You can read more about using Doctave to write your documentation here.
Already have existing docs?
If you have existing documentation, you will have to move them under the
docs/ folder Doctave just
created in the
init step. If you need any assistance migrating your documentation, let us know by
firstname.lastname@example.org and we can help you get up and running.
When you are ready, publish your documentation by uploading them to Doctave! The instructions can be found here.