Docnet defines the following markdown extensions to make writing documentation easier.
To quickly define alert boxes, Docnet defines the @alert element. Three types of alerts are defined: danger (displayed in red), warning (displayed in yellow) and info or neutral, which is displayed in blue. You specify the type of the alert after the @alert statement using @alert name. Close the @alert with @end.
To quickly define alert boxes, Docnet defines the @alert element. Three types of alerts are defined: danger (displayed in red), warning or important (displayed in yellow) and info or neutral, which is displayed in blue. You specify the type of the alert after the @alert statement using @alert name. Close the @alert with @end.
Below are examples for each alert box and the markdown used to create them.
-The markdown:
+The markdown:
@alert danger This is a dangerous text, it will be displayed in a danger alert box! @end
results in
This is a dangerous text, it will be displayed in a danger alert box!
-The markdown:
+The markdown:
@alert warning This is a warning text, it will be displayed in a warning alert box! @end
results in
This is a warning text, it will be displayed in a warning alert box!
-The markdown:
+The markdown:
+@alert important +This is an important text, it will be displayed in a warning/important alert box! +@end +
results in
+This is an important text, it will be displayed in a warning/important alert box!
+The markdown:
@alert info This is an info text, it will be displayed in an info alert box! @end @@ -114,7 +120,7 @@ This is an info text, it will be displayed in an info alert box!InfoThis is an info text, it will be displayed in an info alert box!
Font Awesome icons
To specify a font-awesome icon, use
-@fa-iconname, where iconname is the name of the font-awesome icon.Example: To specify the font awesome icon for GitHub, use
+@fa-github, which will result in:Example: To specify the font awesome icon for GitHub, use
@fa-github, which will result in:Tabs
It's very easy with
Docnetto add a tab control with one or more tabs to the HTML with a simple set of markdown statements. The tab statements are converted into pure CSS3/HTML tabs, based on the work of Joseph Fusco.To start a Tab control, start with
diff --git a/search_index.json b/search_index.json index bc3ab5e..390464c 100644 --- a/search_index.json +++ b/search_index.json @@ -33,7 +33,7 @@ { "location": "markdownextensions.htm", "breadcrumbs": "Home / Authoring content / Writing content using Markdown / DocNet Markdown extensions", - "keywords": "_iconname_ 64 a add after alert Alert alerts an and are as As At awesome Awesome based be Below Between blue box boxes by can Close codepen contents control converted create CSS3 danger dangerous deal define defined defines definition displayed Docnet DocNet documentation each easier easy element end End endtabs example Example examples extensions fa first First followed following font Font for fusco Fusco github GitHub however HTML http icon iconname icons in info interesting into io is it It Joseph label least let make markdown Markdown more name need neutral newline newlines nohighlight nothing Now of on one or pen pretend pure quickly red result results Results second Second see set shows simple special specify start statement statements suffixed tab Tab tabs Tabs text that the The them This those Three to To two type types use used using very warning well where which will with work writing Wvzjrm yellow you You your", + "keywords": "_iconname_ 64 a add after alert Alert alerts an and are as As At awesome Awesome based be Below Between blue box boxes by can Close codepen contents control converted create CSS3 danger dangerous deal define defined defines definition displayed Docnet DocNet documentation each easier easy element end End endtabs example Example examples extensions fa first First followed following font Font for fusco Fusco github GitHub however HTML http icon iconname icons important in info interesting into io is it It Joseph label least let make markdown Markdown more name need neutral newline newlines nohighlight nothing Now of on one or pen pretend pure quickly red result results Results second Second see set shows simple special specify start statement statements suffixed tab Tab tabs Tabs text that the The them This those Three to To two type types use used using very warning well where which will with work writing Wvzjrm yellow you You your", "title": "DocNet Markdown extensions" }, {@tabsand end the tabs definition with@endtabs. Between those two statements, which each need to be suffixed with a newline, you define one or more tabs using@tabfollowed by the label text for that tab, followed by a newline. End your tab contents with@end.