Writerside Help

Projects

A documentation project contains all the configuration and content files necessary for authoring and building your documentation.

Create new documentation project

  1. In the Welcome to Writerside dialog, click New Project.

    If you already have a project open, select File | New Project from the menu bar.

  2. In the New Project wizard, select New Project.

  3. Specify the name and location for your new project.

    If you do not want to start with an empty project, select the options to create the first instance and topic in your new project.

  4. Click Create.

    New Project wizard

Project templates

Writerside includes several project templates, so you do not have to start with an empty project.

Playground

Project with multiple instances and topics to explore the markup and various features

API Docs

Sample API documentation project

For information about importing existing documentation in Markdown, see Import from Markdown.

Project structure

Click The Writerside tool window icon in the left-side tool window bar to open the Writerside tool window and work with your documentation project.

Use the Project tool window to browse various configuration files and resources not accessible from the Writerside tool window.

To open the Project tool window, do one of the following:

  • From the main menu, select View | Tool Windows | Project.

  • Click Project tool window Project on the left-side tool window toolbar.

  • Press Alt+1.

Here is an example of a typical Writerside starter project structure:

Typical project structure

The Writerside directory in the previous example is the help module where all configuration and content files of your documentation project are located. You can name it anything you like, for example docs.

Whenever we talk about the project root of a Writerside documentation project, we actually mean the corresponding help module root. For more information, see Module structure.

Last modified: 18 July 2024