Klemek
6.4 KiB
Welcome to your new blog
If you see this page, that means it's working
Guide to Markdown formatting
- Headers
- Emphasis
- Lists
- Links
- Images
- Code and Syntax Highlighting
- Tables
- Blockquotes
- Inline HTML
- Horizontal Rule
- Line Breaks
- Check Boxes
- Spoilers
- Math Equations
- UML
- Diagrams
- Youtube Videos
Headers
H1
H2
H3
H4
H5
H6
Alternatively, for H1 and H2, an underline-ish style:
Alt-H1
Alt-H2
Emphasis
Emphasis, aka italics, with asterisks or underscores.
Strong emphasis, aka bold, with asterisks or underscores.
Combined emphasis with asterisks and underscores.
Strikethrough uses two tildes. Scratch this.
Lists
- First ordered list item
- Another item
- Unordered sub-list.
-
Actual numbers don't matter, just that it's a number
-
Ordered sub-list
-
And another item.
You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅ Note that this line is separate, but within the same paragraph.⋅⋅ (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
- Unordered list can use asterisks
- Or minuses
- Or pluses
Links
I'm an inline-style link with title
I'm a relative reference to a repository file
You can use numbers for reference-style link definitions
Or leave it empty and use the link text itself.
URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com or http://www.example.com and sometimes example.com (but not on Github, for example).
Some text to show that the reference links can follow later.
Images
Here's our logo (hover to see the title text):
Inline-style:
Reference-style:
Code and Syntax Highlighting
Inline code has back-ticks around it.
var s = "JavaScript syntax highlighting";
alert(s);
s = "Python syntax highlighting"
print s
No language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.
Tables
Colons can be used to align columns.
| Tables | Are | Cool |
|---|---|---|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.
| Markdown | Less | Pretty |
|---|---|---|
| Still | renders |
nicely |
| 1 | 2 | 3 |
Blockquotes
Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.
Quote break.
This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can put Markdown into a blockquote.
Inline HTML
- Definition list
- Is something people use sometimes.
- Markdown in HTML
- Does *not* work **very** well. Use HTML tags.
Horizontal Rule
Three or more...
Hyphens
Asterisks
Underscores
Line Breaks
Here's a line for us to start with.
This line is separated from the one above by two newlines, so it will be a separate paragraph.
This line is also a separate paragraph, but... This line is only separated by a single newline, so it's a separate line in the same paragraph.
Check Boxes
- Task completed
- [] Task to do
Spoilers
Title of the spoiler (click)
Content of the spoiler
On several lines
Math Equations
You can use LaTeX equations with MathJax for full equations and inline ones (based on the number of $) :
\large{\beta=\sum_{i}^{\alpha }\frac{x^{i}}{\alpha}}
Where \alpha is cool
UML
You can use PlantUML diagrams with @startuml and @enduml tags :
@startuml title Article cloud web node nodejs { TCP -right- [express] [showdown] } package data { package "2019/06/18" { component index [ index.md image.png ... ] } } web -down-> TCP : 1. /2019/06/18/title express -down-> index : 2. fetch index -up-> showdown : 3. markdown showdown -left-> express : 4. html express -up-> web : 5. html @enduml
Diagrams
You can use fa-diagrams with @startfad and @endfad tags and using YAML inside
@startuml nodes:
- name: node1 icon: laptop-code color: '#4E342E' bottom: my app
- name: node2 icon: globe color: '#455A64' bottom: world links:
- from: node1 to: node2 color: '#333333' top: icon: envelope bottom: '"hello"' @enduml
Youtube Videos
Just use the "embedded" export on Youtube with dimensions of 535x300 for best results