Markdown template

Click "Edit" to see how all of the things here are written
Note: every preview is placed in admonitions

Basic syntax¶

Extended syntax¶

Quick rundown through syntax available with extensions, which can be explained quickly

Nesting elements¶

uses extension: pymdownx.superfcences

This is a quote

This is a code block

inside a quote

Converting special symbols¶

uses extensions: smarty, pymdownx.smartsymbols

These are the symbols that get replaced:
™ © ®
℅ ± ≠
→ ← ↔
½ ¼ ⅝
1^st 2^nd 3^rd 4^th
« »
…
– —

GitHub links¶

uses extension: pymdownx.magiclink

User mention: @halatnikov
Repository link: halatnikov/linum-framework

Links for Linum:

Issue: #1
Pull request: !1
Discussion: ?1
Commit: 7dbdb07
Diff/Compare: 3fdc4e6...d2e1bec

Links for other repositories:

Issue: STJr/SRB2#206
Pull request: alemart/opensurge!49
Discussion: ppy/osu?13096
Commit: STJr/Kart-Public@7ab1c4a
Diff/Compare: mmatyas/supermariowar@57b639c...3917df2

Converting of existing links:

STJr/SRB2#206
ppy/osu?13096

Also supports Twitter mentions: @holatnikov

A few custom links:

Changelog for versions: 0.1.0 0.2.0

Marking¶

uses extension: pymdownx.mark

This is a marked text
A word can be highlighted too

Inserting (underscoring)¶

uses extension: pymdownx.caret

This is an inserted text
A word can be underscored too

Deleting (strike-through)¶

uses extension: pymdownx.tilde

~~This is a deleted text~~
A ~~word~~ can be ~~striked-through~~ too

Emoji and icons¶

Full list can be found here
uses extension: pymdownx.emoji

Emoji:
Icon (replace all / with -):

Buttons¶

Just a regular link but with an attribute attached
uses extension: attr_list

Empty button

Filled button

Keyboard keys¶

A full list can be found here
uses extension: pymdownx.keys

Ctrl+Alt+Del
Z
Alt+F4
Up+Up+Down+Down+Left+Right+Left+Right+B+A+Enter

Progress bars¶

Colored according to their progress
uses extensions: pymdownx.progressbar, attr_list

Regular:

Can use titles

50%

Full

Striped:

Striped static

Striped animated

Thin:

Superscript¶

Small symbols facing up
uses extension: pymdownx.caret

H²0
This is ^{a superscript}

Subscript¶

Small symbols facing down
uses extension: pymdownx.tilde

CH₃CH₂OH
This is _{a subscript}

Footnotes¶

Usually these are at the bottom of page, but for now they're here
uses extension: footnotes

This is a text¹ that contains 2 footnotes²

This is the content of a first footnote ↩
That's the 2^nd footnote's content ↩

Highlighting changes¶

This has a somewhat limited use scope
uses extension: pymdownx.critic

You can make ~~striked-through text red~~ and underscored text green
And also make comments inline

You can do blocks too!

Tabs¶

uses extension: pymdownx.tabbed

Tab 1Tab 2

this is a tab

it can contain anything

this is a code block in a tab
which is kinda a primary target for these

Abbreviations¶

Only plain text is supported
uses extension: abbr

Regular¶

This can technically be any word whatsoever

With a dictionary¶

See bottom of this file in editor
uses extension: pymdownx.snippets

The INI files that Linum uses are actually converted to JSON in-engine

Admonitions¶

Also known as call-outs
uses extension: admonition

Regular blocks¶

This is a title

This is a text

Look, there's no title

Collapsible blocks¶

uses extension: pymdownx.details

Closed

This is a closed collapsible block

Open

This is an open collapsible block

Types of blocks¶

Click to open

Built-in:

Note

Summary

abstract, tldr

Info

todo

Hint

tip, important

Success

check, done

Help

question, faq

Warning

caution, attention

Fail

missing

Danger

error

Bug

Example

Quote

Code blocks¶

Regular¶

this is an inline code block

this is a code block
	line 2
		line 3

Syntax highlighting¶

uses extensions: pymdownx.highlight, pymdownx.inlinehilite

in an inline code block: [Section]
in a regular code block:

[Section]
key=value
# comment

Adding a title¶

uses extension: pymdownx.highlight

This is a title

indeed it is

Code annotations¶

uses feature flag: content.code.annotate

# comment (1)

this a code annotation, it can be placed anywhere where a comment can be placed in that language

Line numbers¶

uses extension: pymdownx.highlight

can start from any line:

[Section]
key=value
# comment

you can also mark them:

[Section]
key=value
key2=value2
# comment

Embedding external files¶

uses extension: pymdownx.snippets

LinumDefault/levels/example/leveldata/_mapdata.ini

Tables¶

uses extension: tables

Regular¶

this	is a	table
left-aligned	middle-aligned	right-aligned
1	2	3

Sorted table¶

Every table can also be sorted by clicking on headers
uses javascript: tablesort

Number	Alphabetical	Version	Date
0	C	0.1.0	01/Jan/2022
1	B	0.7.8	10/Feb/2022
2	A	0.2.3	20-Mar-2022
5	M	0.1.1	30-Apr-2023
10	Z	1.0.0	02/Dec/2022

Last update: February 24, 2022