Navigation: Creating Markdown Documentation >

Creating Markdown Documentation

Send comments on this topic.



HelpSmith allows you to compile your help project to the Markdown format, which is a lightweight markup language that uses simple syntax to add various formatting elements (e.g. headings, hyperlinks, images, tables, etc.) to a plain text file.


Since a Markdown document is technically a plain text file, it can be viewed by using a regular text editor application (e.g. Notepad), or a specialized Markdown reader application that can display it as a structured and formatted document.


Key advantages of the Markdown format

You can use Markdown as a fast way to create a formatted document by using a plain text editor.

A Markdown document is portable meaning that it can be viewed on any computer or mobile device.

The Markdown format is supported by many popular applications and web-services.


Compile Markdown Documentation

1.On the Project tab, in the Project group, click Compile.

2.In the Compile Project dialog, in the Output Format box, select Markdown.

3.If necessary, select build tags and other options that you want to apply to this compilation.

4.Click OK.


Remark: You can also access the Compile Project dialog by pressing F9.


Quick Compilation with the Previous Options

You can skip the Compile Project dialog and apply the previously used options including the build tags that were selected for this output help format:

1.On the Project tab, in the Project group, click the lower half of the Compile button.

2.In the popup menu, under Quick Compilation, click Markdown.


Batch Compilation Mode

If necessary, you can use the batch compilation mode that allows you to compile documentation in multiple output formats, or to generate different versions of the same help file (by using build tags) with a single click. You can visit this topic for more details on how to add a new compilation task.


Markdown Output Directory

When you compile your help project to the Markdown format, you can use the default output directory or specify a custom location for the documentation files.


By default, HelpSmith puts the files of the generated Markdown documentation to the "Markdown" folder located in the same directory as the project file. If your help project has never been saved, HelpSmith will use your Windows "My Documents" folder as the default output directory.


Distributing Markdown Documentation

The output folder defined for the Markdown format stores all the files of the generated documentation, and this is the folder that you need when you want to publish the documentation, or distribute it to other people.


Customization Options for Markdown Format

For Markdown documentation, HelpSmith allows you to specify the preferred syntax to use for headings, lists, and other elements. Also, you can specify how the hyperlinks will be exported, and set other options:

General Options

Contents Options

Links Options

Images Options

Copyright © 2007-2024