-
Notifications
You must be signed in to change notification settings - Fork 133
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Tidy up formattingContents user guide page
- Add section on markdown attributes (attributes.mbdf) - Fix a minor spelling error in formattingContents.md - Add missing newline at eof (images.mbdf, tables.mbdf) - Add relative link example using markdown (links.mbdf) - Add starting list number trick example (lists.mbdf)
- Loading branch information
Showing
7 changed files
with
111 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
## Classes, Attributes & Identifiers | ||
|
||
Most markdown syntax above this section supports adding classes, attributes and identifiers | ||
using [pandoc](https://pandoc.org/MANUAL.html) syntax without the need for a wrapper html element. | ||
|
||
The syntax is `{.class-name attribute="value" attribute=value #id}`, which is placed at different locations depending | ||
on the type of markdown. | ||
|
||
<include src="codeAndOutput.md" boilerplate > | ||
<variable name="highlightStyle">markdown</variable> | ||
<variable name="code"> | ||
Apply classes, attributes, identifiers to block level markdown (eg. paragraphs, headings) | ||
by leaving a space before '{' {.text-success #attribute-example} | ||
|
||
#### heading {.text-info} | ||
|
||
--- {.border-danger} | ||
|
||
Apply the same to inline markdown (eg. bold text) by | ||
omitting the **space**{.text-primary .bg-light attribute=value} | ||
</variable> | ||
</include> | ||
|
||
Some other types of markdown have **different placements** of the curly group `{...}`. {.mb-4} | ||
|
||
****Unordered and Ordered lists**** | ||
|
||
<include src="codeAndOutput.md" boilerplate > | ||
<variable name="highlightStyle">markdown</variable> | ||
<variable name="code" id="list-example"> | ||
* Apply to the list item itself like so {.text-success #list-item-id} | ||
* Curly groups after newlines apply to the closest nested list {.text-danger} | ||
{.bg-light} | ||
* Curly groups two lines after the last line apply to the top most list | ||
|
||
{.alert-info} | ||
</variable> | ||
</include> | ||
|
||
****Fenced code blocks**** | ||
|
||
Refer to the above [section](../formattingContents.html#line-numbering)! | ||
|
||
<small>For a more detailed guide, see: https://www.npmjs.com/package/markdown-it-attrs</small> | ||
|
||
<box type="warning" seamless> | ||
Formatting features listed above this section support this syntax for attributes, classes and identifiers. | ||
Those below this section do not. | ||
</box> | ||
|
||
<!-- Full syntax reference --> | ||
<span id="short" class="d-none"> | ||
|
||
``` | ||
add a space before '{' for block level markdown {.class-name attribute="value" attribute=value #id} | ||
|
||
don't add a space for **inline**{.text-danger} markdown | ||
``` | ||
<small>For a more detailed guide, see: https://www.npmjs.com/package/markdown-it-attrs</small> | ||
</span> | ||
|
||
<!-- Reader facing features --> | ||
<span id="examples" class="d-none"> | ||
<include src="attributes.mbdf#list-example" /> | ||
</span> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,4 +34,4 @@ Animal | Trainable?| Price | Remarks | |
Ants | no | 5 | | ||
Bees | no | 20 | | ||
Cats|yes|100| | ||
</span> | ||
</span> |