Writerside
 
Shortcuts: Windows
Get Writerside

Projects

Last modified: 06 March 2025

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

Writerside allows you to create a dedicated documentation project or add your documentation sources to your development project.

Create new documentation project

  1. From the main menu, select File | New | Project.

  2. In the New Project wizard, select Writerside on the left, then select Starter Project, and then click Next.

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

Add documentation to existing project

  1. Open your existing development project.

  2. In the Writerside tool window, click Add documentation, select To Current Project, and then click New.

    add_new_instance

  3. Specify a name for the first help instance and click OK.

Project templates

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

Starter Project

Minimalistic starter project with one help instance and a sample Markdown topic to get you started

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.

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.