How to format text

• Text within paragraphs
• Enumeration lists
• Hyperlinks
• Code blocks
• Head lines

Text within paragraphs

// MyTopic.markdown
This is a <em>rather important</em> and this is a <strong>very important</strong> topic (html tags: em, strong)
This is a *rather important* and this is a **very important** topic (markdown: asterisk)
This is a _rather important_ and this is a __very important__  topic (markdown: underscore)
 
Use names from code like `void SomeFunction(int in_val)` and `MyClass` (markdown: backtick).

Resulting output format:

This is a rather important and this is a very important topic (html tags: em, strong) This is a rather important and this is a very important topic (markdown: asterisk) This is a rather important and this is a very important topic (markdown: underscore) Use names from code like void SomeFunction(int in_val) and MyClass (markdown: backtick).

Enumeration lists

// MyTopic.markdown
#### Simple list (markdown: -):
− This is a simple enumeration
  − This is an enumeration of level 2
    − This is an enumeration of level 3
    − This is another enumeration of level 3
  − This is also an enumeration of level 2
− Now we are back at level 1 enumeration
 
#### Numbered list (markdown: -#):
−# This is a simple enumeration
  −# This is an enumeration of level 2
    −# This is an enumeration of level 3
    −# This is another enumeration of level 3
  −# This is also an enumeration of level 2
−# Now we are back at level 1 enumeration

Resulting output format:

Simple list (markdown: -): This is a simple enumeration This is an enumeration of level 2 This is an enumeration of level 3 This is another enumeration of level 3 This is also an enumeration of level 2 Now we are back at level 1 enumeration Numbered list (markdown: -#): This is a simple enumeration This is an enumeration of level 2 This is an enumeration of level 3 This is another enumeration of level 3 This is also an enumeration of level 2 Now we are back at level 1 enumeration

Hyperlinks

// MyTopic.markdown
Linking to other contents:
− Internal link to other chapter (defined by DoxyGen \defgroup): \ref GrpAboutThisDoc (DoxyGen commmand \ref)
− Internal link to other chapter (defined by DoxyGen \defgroup): [Overview](\ref GrpAboutThisDoc) (DoxyGen commmand \ref)
− Simple external link: http://www.doxygen.org/ (no special format needed)
− External link with user defined name: [DoxyGen](http://www.doxygen.org/) (markdown [])
− External link with user defined name: [DoxyGen](http://www.doxygen.org/ "External page at DoxyGen.org") (markdown [] with link title)
− External link with user defined name: <a href="http://www.doxygen.org/">DoxyGen</a> (html tag a)

Resulting output format:

Linking to other contents: Internal link to other chapter (defined by DoxyGen \defgroup): About this documentation (DoxyGen commmand \ref) Internal link to other chapter (defined by DoxyGen \defgroup): Overview (markdown [](\ref)) Simple external link: http://www.doxygen.org/ (no special format needed) External link with user defined name: DoxyGen (markdown []) External link with user defined name: DoxyGen (markdown [] with link title) External link with user defined name: DoxyGen (html tag a)

Code blocks

Simple format

To format a text section as a code sample simply insert an empty line after the preceding paragraph and make an indentation of at least 4 spaces in each line of the code block:

// MyTopic.markdown
...
This is regular text.
 
    class A{};
    const char* MY_FILE = "Demo.xml";
  
    int func(int a,int b) { return a*b; }
    do{..} while(true);
 
This again is regular text.

Resulting output format:

This is regular text. class A{}; const char* MY_FILE = "Demo.xml"; int func(int a,int b) { return a*b; } do{..} while(true); This again is regular text.

Syntax highlighting

To use syntax highlighting start and end the code section with a line of ˜. At the end of the first line specifiy the language for which to activate syntax highlighting:

// MyTopic.markdown
This is regular text.
 
˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜{.cpp}
class A{};
const char* MY_FILE = "Demo.xml";
 
int func(int a,int b) { return a*b; }
do{..} while(true);
˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜
 
This again is regular text.

Resulting output format:

This is regular text. class A{}; const char* MY_FILE = "Demo.xml"; int func(int a,int b) { return a*b; } do{..} while(true); This again is regular text.

Line numbers (but no syntax highlighting)

By omitting the language specification at the begin of the code block you will get line numbers in the resulting output:

// MyTopic.markdown
This is regular text.
 
˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜
class A{};
const char* MY_FILE = "Demo.xml";
 
int func(int a,int b) { return a*b; }
do{..} while(true);
˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜˜
 
This again is regular text.

Resulting output format:

This is regular text. class A{}; const char* MY_FILE = "Demo.xml"; int func(int a,int b) { return a*b; } do{..} while(true); This again is regular text.

Head lines

You can use html commands or implicit markdown formatting within your markdown file:

// MyTopic.markdown
...
Header of level 1 (markdown: underline ==)
=========================================
 
Header of level 2 (markdown: underline --)
-----------------------------------------
 
# Header of level 1 (markdown syntax #)
## Header of level 2 (markdown syntax ##)
### Header of level 3 (markdown syntax ###)
#### Header of level 3 (markdown syntax ####)
 
<h1>Header of level 2 (html tag h1)</h1>
<h2>Header of level 2 (html tag h2)</h2>
<h3>Header of level 3 (html tag h3)</h3>
<h4>Header of level 3 (html tag h3)</h4>

Resulting output format:

Header of level 1 (markdown: underline ==) Header of level 2 (markdown: underline –) Header of level 1 (markdown syntax #) Header of level 2 (markdown syntax ##) Header of level 3 (markdown syntax ###) Header of level 4 (markdown syntax ####) Header of level 2 (html tag h1) Header of level 2 (html tag h2) Header of level 3 (html tag h3) Header of level 3 (html tag h3)