Editing Project Options / Markdown Export /

Markdown: General Options

Send comments on this topic

← Previous Next →

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

2.In the Project Options dialog, in the left sidebar, click Markdown.

3.Change the parameters that you need.

4.Click OK.

Below is a description of the parameters in this section.

Heading 1

Specifies the syntax to use to denote the Heading 1 element in the Markdown document.

Remark: If you use a line (===) instead of the hash (#) chars for the Heading 1 element, you can also select auto-length mode, so the line will have the length of the title, or specify a fixed length value.

Heading 2

Specifies the syntax to use to denote the Heading 2 element(s) in the Markdown document.

Remark: If you use a line (---) instead of the hash (#) chars for the Heading 2 elements, you can also select auto-length, so the line will have the length of the title, or specify a fixed length value.

Bulleted List

Specifies the syntax to use to denote a bulleted list in the Markdown document.

Numbered List

Specifies the syntax to use to denote a numbered list in the Markdown document.

Horizontal Line

Specifies the syntax to use to denote a horizontal line in the Markdown document.

Remark: For a horizontal line, you can also specify the length value that you prefer.

Allow Underlined Text

If set, underlined text will be denoted by using the format: ++some text++.

Remark: By default, this option is disabled since not all Markdown readers support this formatting element.

Lower case for filenames

If selected, HelpSmith will automatically convert all filenames within the Markdown output folder into the lower case.

Remark: If you activate this option on an existing help project for the first time, you may need to clear your Markdown output folder and re-compile the help project.

SEO friendly filenames

Allows you to generate SEO-friendly filenames for topics in the Markdown output folder.

HelpSmith uses topic IDs to generate names for the topic files. If this option is selected, the "_" characters in the filenames will be replaced with hyphens "-".

Default topic template

Allows you to set the default template that will be applied to the topics when you compile Markdown documentation. Please note that individual topics can override this setting, and either use a different template or use no template.