arkdown

a text-to-HTML conversion tool for web writers

Banner

Bookmarks

5 items
Awesome Markdown
Awesome Markdown
Slidev
Slidev
Slidev
Markdown Guide
Markdown Guide
Markdown Guide
Awesome Rehype
Awesome Rehype
Awesome Remark
Awesome Remark
The below cheatsheet is an amalgamation between
im-luka/markdown-cheatsheet and adam-p/markdown-here/wiki/
Table of Contents

Blockquotes

> This is a blockquote.
> Want to write on a new line with space between?
>
> > And nested? No problem at all.
> >
> > > PS. you can **style** your text _as you want_.

Code

Inline `code` has `back-ticks around` it.

Blocks of code are fenced by lines with three back-ticks ``` or are indented with four spaces.

List of supported languages

Sourced from https://github.com/jincheng9/markdown_supported_languages

  • Cucumber (*.feature)
  • abap (*.abap)
  • ada (.adb, .ads, *.ada)
  • ahk (.ahk, .ahkl)
  • apacheconf (.htaccess, apache.conf, apache2.conf)
  • applescript (*.applescript)
  • as (*.as)
  • as3 (*.as)
  • asy (*.asy)
  • bash (.sh, .ksh, .bash, .ebuild, *.eclass)
  • bat (.bat, .cmd)
  • befunge (*.befunge)
  • blitzmax (*.bmx)
  • boo (*.boo)
  • brainfuck (.bf, .b)
  • c (.c, .h)
  • cfm (.cfm, .cfml, *.cfc)
  • cheetah (.tmpl, .spt)
  • cl (.cl, .lisp, *.el)
  • clojure (.clj, .cljs)
  • cmake (*.cmake, CMakeLists.txt)
  • coffeescript (*.coffee)
  • console (*.sh-session)
  • control (control)
  • cpp (.cpp, .hpp, .c++, .h++, .cc, .hh, .cxx, .hxx, *.pde)
  • csharp (*.cs)
  • css (*.css)
  • cython (.pyx, .pxd, *.pxi)
  • d (.d, .di)
  • delphi (*.pas)
  • diff (.diff, .patch)
  • dpatch (.dpatch, .darcspatch)
  • duel (.duel, .jbst)
  • dylan (.dylan, .dyl)
  • erb (*.erb)
  • erl (*.erl-sh)
  • erlang (.erl, .hrl)
  • evoque (*.evoque)
  • factor (*.factor)
  • felix (.flx, .flxh)
  • fortran (.f, .f90)
  • gas (.s, .S)
  • genshi (*.kid)
  • gitignore (.gitignore)
  • glsl (.vert, .frag, *.geo)
  • gnuplot (.plot, .plt)
  • go (*.go)
  • groff (.(1234567), .man)
  • haml (*.haml)
  • haskell (*.hs)
  • html (.html, .htm, .xhtml, .xslt)
  • hx (*.hx)
  • hybris (.hy, .hyb)
  • ini (.ini, .cfg)
  • io (*.io)
  • ioke (*.ik)
  • irc (*.weechatlog)
  • jade (*.jade)
  • java (*.java)
  • js (*.js)
  • jsp (*.jsp)
  • lhs (*.lhs)
  • llvm (*.ll)
  • logtalk (*.lgt)
  • lua (.lua, .wlua)
  • make (.mak, Makefile, makefile, Makefile., GNUmakefile)
  • mako (*.mao)
  • maql (*.maql)
  • mason (.mhtml, .mc, *.mi, autohandler, dhandler)
  • markdown (*.md)
  • modelica (*.mo)
  • modula2 (.def, .mod)
  • moocode (*.moo)
  • mupad (*.mu)
  • mxml (*.mxml)
  • myghty (*.myt, autodelegate)
  • nasm (.asm, .ASM)
  • newspeak (*.ns2)
  • objdump (*.objdump)
  • objectivec (*.m)
  • objectivej (*.j)
  • ocaml (.ml, .mli, .mll, .mly)
  • ooc (*.ooc)
  • perl (.pl, .pm)
  • php (.php, .php(345))
  • postscript (.ps, .eps)
  • pot (.pot, .po)
  • pov (.pov, .inc)
  • prolog (.prolog, .pro, *.pl)
  • properties (*.properties)
  • protobuf (*.proto)
  • py3tb (*.py3tb)
  • pytb (*.pytb)
  • python (.py, .pyw, .sc, SConstruct, SConscript, .tac)
  • r (*.R)
  • rb (.rb, .rbw, Rakefile, .rake, .gemspec, .rbx, .duby)
  • rconsole (*.Rout)
  • rebol (.r, .r3)
  • redcode (*.cw)
  • rhtml (*.rhtml)
  • rst (.rst, .rest)
  • sass (*.sass)
  • scala (*.scala)
  • scaml (*.scaml)
  • scheme (*.scm)
  • scss (*.scss)
  • smalltalk (*.st)
  • smarty (*.tpl)
  • sourceslist (sources.list)
  • splus (.S, .R)
  • sql (*.sql)
  • sqlite3 (*.sqlite3-console)
  • squidconf (squid.conf)
  • ssp (*.ssp)
  • tcl (*.tcl)
  • tcsh (.tcsh, .csh)
  • tex (.tex, .aux, *.toc)
  • text (*.txt)
  • v (.v, .sv)
  • vala (.vala, .vapi)
  • vbnet (.vb, .bas)
  • velocity (.vm, .fhtml)
  • vim (*.vim, .vimrc)
  • xml (.xml, .xsl, .rss, .xslt, .xsd, .wsdl)
  • xquery (.xqy, .xquery)
  • xslt (.xsl, .xslt)
  • yaml (.yaml, .yml)

Comments

<!-- This content will not appear in the rendered Markdown -->

Emphasis

Emphasis (italics) with *asterisks* or _underscores_.

Strong emphasis (bold) with **asterisks** or __underscores__.

Combined emphasis with **asterisks and _underscores_**.

Strikethrough uses two tildes. ~~Scratch this.~~

Headings

# H1
## H2
### H3
#### H4
##### H5
###### H6

<!-- Alternatively, for H1 and H2, an underline-ish style: -->

Alt-H1
======

Alt-H2
------

Horizontal Rule

Three or more...

--- <!-- Dashes -->
*** <!-- Asteriks -->
___ <!-- Underscores -->

Images

hover to see the title text:

Inline-style: 
![alt text](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Logo Title Text 1")

Reference-style: 
![alt text][logo]

[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Logo Title Text 2"
[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")

[I'm a reference-style link][Arbitrary case-insensitive reference text]

[I'm a relative reference to a repository file](../blob/master/LICENSE)

[You can use numbers for reference-style link definitions][1]

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.

[arbitrary case-insensitive reference text]: https://www.mozilla.org
[1]: http://slashdot.org
[link text itself]: http://www.reddit.com

Lists

1. First ordered list item
2. Another item
⋅⋅* Unordered sub-list. 
1. Actual numbers don't matter, just that it's a number
⋅⋅1. Ordered sub-list
4. 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

Tables

Colons can be used to align columns.

| Default    | Left align | Center align | Right align |
| ---------- | :--------- | :----------: | ----------: |
| 9999999999 | 9999999999 | 9999999999   | 9999999999  |
| 999999999  | 999999999  | 999999999    | 999999999   |
| 99999999   | 99999999   | 99999999     | 99999999    |
| 9999999    | 9999999    | 9999999      | 9999999     |

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