skip to main content
Output Formats » Markdown++ Output Format » Configuration Tasks for Markdown++
Configuration Tasks for Markdown++
Markdown++ in ePublisher offers powerful configuration options to enhance the versatility and control of your Markdown output. By fine-tuning settings such as the Markdown Syntax and Indentation Level properties for paragraph and character styles, you can produce highly structured, readable, and stylistically consistent Markdown documents. These configuration tasks empower technical writers to create sophisticated layouts that retain compatibility with other Markdown tools while leveraging Markdown++’s advanced capabilities. This section provides guidance on these essential configuration tasks, helping you set up a seamless Markdown workflow that meets both organizational standards and the demands of complex technical documentation.
Configuring Each Paragraph and Character Style's Markdown Syntax Property
The Markdown Syntax property in ePublisher's Markdown++ output format allows you to control the specific Markdown representation for both paragraph and character styles. While the default setting of Auto-Detect often yields acceptable results, configuring each style’s Markdown syntax explicitly ensures consistent formatting and improves output quality, especially for production workflows.
Setting the Paragraph Style's Markdown Syntax Property
By default, the Markdown Syntax property for paragraph styles is set to Auto-Detect, which infers the appropriate Markdown based on the source paragraph’s structure and formatting. For greater control, especially when preparing final documentation, you can specify an explicit Markdown syntax from the following options:
  • Title 1, Title 2, Heading 1, Heading 2, Heading 3, Heading 4, Heading 5, Heading 6: Corresponds to Markdown heading syntax (e.g., #, ##, etc.). Use these options to explicitly set headers for different sections.
  • Unordered List, Ordered List: Configures paragraphs to render as list items, aligning with Markdown’s list syntax (-, or numbered).
  • Blockquote: Formats paragraphs as blockquotes using the > character in Markdown.
  • Code Fence: Renders content within a fenced code block, using backticks (```).
  • None: Renders the content as a plain paragraph without additional Markdown syntax, recommended when there is no specific formatting required.
To configure a paragraph style’s Markdown Syntax property:
  1. In ePublisher Designer, open the Style Designer for your project.
  2. Select the Paragraph Style you wish to configure.
  3. Locate the Markdown Syntax property.
  4. Choose the desired setting from the dropdown list, or keep Auto-Detect if unsure.
  5. Save your settings to apply changes to the Markdown++ output.
Tip: If you’re uncertain of the specific Markdown syntax, set the property to None for a plain paragraph appearance.
Setting the Character Style's Markdown Syntax Property
The Markdown Syntax property for character styles defines inline formatting, such as bold or italic text. The available options are:
  • Bold: Formats text in bold (**text**).
  • Italic: Formats text in italics (*text*).
  • Strikethrough: Formats text with strikethrough (~~text~~).
  • Code: Renders text within inline code format using backticks (`text`).
  • None: Renders the text without additional Markdown syntax.
To configure a character style’s Markdown Syntax property:
  1. In ePublisher Designer, open the Style Designer for your project.
  2. Select the Character Style you wish to configure.
  3. Locate the Markdown Syntax property.
  4. Choose an explicit setting (e.g., Bold, Italic), or use Auto-Detect if unsure.
  5. Save your settings to apply changes to the Markdown++ output.
Recommendation: For best results in production, avoid Auto-Detect and explicitly configure each style’s Markdown Syntax property. This ensures clarity and consistency across your Markdown++ documentation.
Configuring Each Paragraph Style's Markdown Indentation Level Property
The Indentation Level property in ePublisher’s Markdown++ output format allows you to create nested paragraph structures, providing flexibility in organizing content hierarchically. This property applies only to paragraph styles and controls whether a paragraph nests under its preceding sibling paragraph—the paragraph immediately before it in the document structure.
By default, Indentation Level is set to None, preventing any indentation relative to the preceding paragraph. However, by configuring this property to a value of 1 or higher, you can create multi-level structures, such as nested lists, indented blockquotes, or even complex outline formats.
How Indentation Works
When set to 1 or more, the Indentation Level property will nest the paragraph one level beneath its preceding sibling, but only if:
  1. The preceding sibling paragraph is configured as a container paragraph—that is, a paragraph that allows nesting.
  2. The preceding sibling’s Markdown Syntax property is set to one of the following container-compatible formats:
    • Unordered List
    • Ordered List
    • Blockquote
Note: A paragraph’s indentation level cannot exceed one level beneath the preceding sibling, but it can nest as deep as the structure allows, based on the indentation of previous paragraphs.
Setting Indentation Levels
To configure a paragraph style’s indentation level:
  1. In ePublisher Designer, open the Style Designer for your project.
  2. Select the Paragraph Style you wish to configure.
  3. Locate the Indentation Level property.
  4. Set the Indentation Level to the desired number (1 or greater) to enable nesting.
  5. Save your settings to apply changes to the Markdown++ output.
Example Use Cases
The Indentation Level property provides a powerful way to structure Markdown content. Here are some examples:
  • Nested Lists: Create lists within lists by setting the Indentation Level on each successive list item style. This structure is ideal for outlines, multi-tiered content, or Harvard-style lists.
  • Blockquote Content Islands: Place an indented paragraph within a blockquote, allowing for multiple paragraphs nested under a single quote. This technique is effective for formatting testimonials, quoted sections, or side content within a primary narrative.
The Indentation Level property, combined with other Markdown++ formatting options, allows for sophisticated document structures that can elevate your Markdown presentations.
Was this helpful?
Last modified date: 11/15/2024