Start using CodeGuide in 3 steps.

1. Download the app.
2. Create code-guide.json configuration file in the root directory of your project. See the section below for the content of this file.
3. Open your project directory in the app.

code-guide.json configuration file

Your project’s root folder should contain a code-guide.json configuration file. The CodeGuide app uses this file to display your docs.

Sample config

Following is a sample code-guide.json config file.

{
  "directory": "./guides"
}

Available configurations

The follow table shows the attributes supported by the code-guide.json config file.