Using Markdown - SSWConsulting/SSW.Rules.Content GitHub Wiki
Hint: To understand why Markdown is awesome, read Do you use Markdown to store your content?
You can use https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet for a complete guide to generic Markdown.
Have a look at our Example Rule + Markdown Cheatsheet for specific elements on SSW Rules.
You can add images, tables, and video, according to Markdown formatting. Below are some of the basics to give you a head start.
Headings:
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Links:
[I'm an inline-style link](https://www.google.com)
[I'm an inline-style link with title](https://www.google.com "Google's Homepage")`
Tables:
Colons can be used to align columns.
| Tables | Are | Cool |
| ------------- |:-------------:| -----:|
| col 3 is | right-aligned | 600 |
| col 2 is | centered | 2 |
| zebra stripes | are neat | |
Video:
`youtube: 2G7z2mF7Onk`
Quote:
> A quote looks like this
image:
See the examples on the sample rule
All images have borders on SSW.Rules, but in some cases it might look better without a border.
To add image with no border, use the no-border fenced block
::: no-border
:::
SSW fenced blocks
SSW has created some fenced blocks that you can use to make your rules even better.
Check them out on this sample page.
Warnings
Spaces in blank/new line after tags:
Please ensure to check carefully that there's no extra spaces in a blank/new line after tags, otherwise the build will break and throw an out-of-memory error. Figure: Remove extra spaces in a blank/new line after tags
Consecutive greyboxes:
Use consecutive greyboxes containing bolded text with caution... Make sure there are 2 empty lines between consecutive greyboxes (with bolded text), otherwise the build will break and throw an out-of-memory error.
::: greybox
**Guggenheim**
:::
::: bad
Bad example – it is a word that other people know
:::
::: greybox
**Mymistresseyesarenothinglikethesun**
:::
::: bad
Bad example – It’s the opening to one of Shakespeare’s sonnets so is known to other people (and painful to type in)
:::
❌ Figure: Bad example - Consecutive greyboxes with 1 empty line between them
::: greybox
**Guggenheim**
:::
::: bad
Bad example – it is a word that other people know
:::
::: greybox
**Mymistresseyesarenothinglikethesun**
:::
::: bad
Bad example – It’s the opening to one of Shakespeare’s sonnets so is known to other people (and painful to type in)
:::
::: greybox
**4yearicecreamcat**
:::
::: good
Good example – it is 16 characters, composed of 5 words, is not a phrase that is known by anyone else, and is easy (for you) to remember
:::
✅ Figure: Good example - Consecutive greyboxes with 2 empty lines between them