Markdown++ Basics

Authoring Source Documents » Markdown++ Source Documents » Learning Markdown++ » Markdown++ Basics

Markdown++ Basics

Markdown++ is a superset of Markdown. Because of this, all Markdown files are also Markdown++ files. Any tools used for Markdown also work well for Markdown++.

Filling out Markdown with a full designing & publishing experience, while also maintaining readability, is a major design goal of Markdown++. Another goal is to preserve the integrity of rendering and previews across the many Markdown tools out there.

Markdown++ uses the HTML Comment tag with a set of commands inside them for most of it's features. Using these enables Markdown++ syntax to be transparent when documents are rendered or previewed, and aids in quick learning by using a well-established pattern.

Learning the HTML Comment tag opens the door to learning most of the features Markdown++ offers.

Syntax

Write an HTML Comment by starting with . Any text can be written between these two patterns. Keeping the entire comment on a single line is required by Markdown++.

Any unrecognized text inside of a comment gets treated as a regular HTML comment and carries through to the output.

Basics

A simple comment tag with a Custom Style Name command. Keep the tag on a single line.

<!--style:CustomStyle-->

Apply commands to block-level elements by adding the tag to the line directly above the block element. The style CustomParagraph is added to a paragraph below.

<!-- style:CustomParagraph -->
A customized paragraph, named "CustomParagraph".

Apply commands to inline elements by adding the tag directly before the inline syntax. Don't put space between the comment tag and the inline syntax. The style CustomBold is added to bold text below.

Customizing some <!--style:CustomBold-->**bold text**.

Whitespace OK

In general, it is safe to include any amount of whitespace between the comment tags. Use it as necessary for readability.

<!-- style: CustomStyle -->

Multiple Commands

Any number of commands can be put inside the comment. Separate the commands with a ; character. This example applies two commands to a Heading 1: a Custom Style Name, and a Custom Alias.

<!-- style:CustomHeading1 ; #custom-heading1 -->
# Heading 1

Start & End Tags

Some features, like Conditional Text, require start & end tags. The example wraps condition tags around content meant only for printed publications.

<!--condition:print_only-->
## Print Only

This ccontent is meant for print only.
<!--/condition-->

Was this helpful?

Last modified date: 11/15/2024