Slate Markdown
Lukas White introduces Slate - a Markdown way of writing your API documentation - and shows you how to publish it to Github pages for free hosting. Download Dahlia Sky - Mark Wood - Taking Down a Club Slut porn video from femdom-life.com - the best female domination porn videos tube with exclusive collection for free or with premium account.
This is a reference for the Markdown syntax used in Slate.
Headers
For headers:
Note that only level 1 and 2 headers will appear in the table of contents.
Paragraph Text
For normal text, just type your paragraph on a single line.
Make sure the lines above and below your paragraph are empty.
Code Samples
For code samples:
Slate Markdown Meaning
Code samples will appear in the dark area to the right of the main text. We recommend positioning code samples right under headers in your markdown file.
For the full list of supported languages, see rouge.
Slate Markdown 2019
Code Annotations
For code annotations:
Code annotations are essentially the same thing as paragraphs, but they'll appear in the area to the right along with your code samples.
Formatting code annotations (right column) with its explanation (center column)
In order to correctly format the code in the right column with the text in the center column the code snippet should go first, e.g.
Putting the content for the center column first and the code snippet afterwards will cause the code snippet to be aligned with the last line of the center column, if the code snippet goes first, then the code is aligned with the first line of the center column.
Tables
Slate uses PHP Markdown Extra style tables:
Note that the pipes do not need to line up with each other on each line.
If you don't like that syntax, feel free to use normal html <table>
s directly in your markdown.
Formatted Text
You can use those formatting rules in tables, paragraphs, lists, wherever, although they'll appear verbatim in code blocks.
Lists
Nested Lists
You can do sub-lists in Markdown by indenting the bullets (or numbers) by 4 spaces:
Will give you:
Links
Notes and Warnings
You can add little highlighted warnings and notes with just a little HTML embedded in your markdown document:
Use class='notice'
for blue notes, class='warning'
for red warnings, and class='success'
for green notes.
Markdown inside HTML blocks won't be processed.
Need Help?
If you have trouble with any of the syntax, or if it's confusing, let us know by filing an issue. Thanks!