Sign Up

Creating a Project

Now that you have install the desktop app, let's create your first project.

Create a local docs directory

First, let's create a location for your docs on your local machine. This can be in a subdirectory of an existing Git repository, or a brand new repository.

# Go to your repository
cd path/to/my/project

# Create a location for your documentation
mkdir docs

Create a starter project

Next, we will use the Doctave desktop app that we just installed to setup a Doctave project in the folder you just created:

  1. Open the Doctave desktop app
  2. Click the "Create new project" button
  3. Select the folder you created in the previous step.

Once selected, the app will generate a basic structure for your docs, and display it for you.

Congrats! You now have a functioning Doctave docs site running locally! ğŸŽ‰

Try editing the README.md file in the editor of your choice and see what happens. The desktop app will update automatically once you save your changes.


Next, let's look at how documentation can be written and edited in Doctave.

Was this page helpful?