documon
Version:
A documentation system for mortals. Use with any language.
180 lines (143 loc) • 5.33 kB
HTML
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Markdown Cheatsheet</title>
<meta name="description" content="more.comment_authoring_guide.markdown_cheatsheet">
<!-- Normalize -->
<link rel="stylesheet" href="assets/vendor/normalize.css">
<!-- prettify -->
<link rel="stylesheet" href="assets/vendor/prettify/codamike.css">
<script src="assets/vendor/prettify/prettify.js"></script>
<!-- Documon Pages Info. (Used by various classes to identify this page.) -->
<script>
var pageCtx = {
id : "more.comment_authoring_guide.markdown_cheatsheet",
name: "Markdown Cheatsheet"
}
</script>
<!-- theme
<link rel="stylesheet" href="assets/fonts/Fira_Sans/FiraSans.css">
<link rel="stylesheet" href="assets/fonts/Inconsolata/inconsolata.css">
-->
<link rel="stylesheet" href="assets/css/pages.css">
<script src="assets/js/documon/Storage.js"></script>
<script src="assets/js/documon/Access.js"></script>
<script src="assets/js/documon/Pages.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-106684927-1', 'auto');
ga('send', 'pageview');
</script>
</head>
<body>
<div class="page">
<div class="more"><h1 id="markdown-cheatsheet">Markdown Cheatsheet</h1>
<p>Other nice visual references:</p>
<ul>
<li><a href="https://markdown-it.github.io/">https://markdown-it.github.io/</a></li>
<li><a href="https://en.support.wordpress.com/markdown-quick-reference/">https://en.support.wordpress.com/markdown-quick-reference/</a></li>
</ul>
<h2 id="headings">Headings</h2>
<pre><code># h1 Heading
## h2 Heading
### h3 Heading
#### h4 Heading
##### h5 Heading
###### h6 Heading</code></pre>
<h2 id="horizontial-rule">Horizontial Rule</h2>
<p>(3 or more dash or underscore characters)</p>
<pre><code>--- or ___</code></pre>
<h2 id="italic">Italic</h2>
<pre><code>*my words* or _my words_</code></pre>
<h2 id="bold">Bold</h2>
<pre><code>**my words** or __my words__</code></pre>
<h2 id="links">Links</h2>
<p>Inline:</p>
<pre><code>[display text](http://example.com "Shows when hover")</code></pre>
<p>Referenced:</p>
<pre><code>For more [click me][1] and another [or me][2].
-- then somewhere else (like at the bottom of the page) ---
[1]: http://example.com/ "Shows when hover 1"
[2]: http://example.org/ "Shows when hover 2"</code></pre>
<h2 id="images">Images</h2>
<p>Bare bones:</p>
<pre><code></code></pre>
<p>All the bells and whistles</p>
<pre><code></code></pre>
<p>Referenced</p>
<pre><code>![][1]
-- then somewhere else (like at the bottom of the page) ---
[1]: url/to/image.jpg "Shows when hover 1"</code></pre>
<p>Linked image (simple)</p>
<pre><code>Click this image [](http://example.com/)</code></pre>
<p>Linked image (bells and whistles)</p>
<pre><code>Click this image [](http://example.com/ "Hover text here")</code></pre>
<h2 id="blockquotes">Blockquotes</h2>
<pre><code>> Add a ">" symbol in front of paragraph.
> Connected ">" symbols (vertically)
> get lumped together as one.</code></pre>
<p><strong>Code within blockquotes</strong><br />
Use a tab or spaces like usual, just pretend the > is the edge. <strong>IMPORTANT:</strong> Multi-line code requires one additional blockquote > after the code all by itself at the bottom.</p>
<pre><code> > function(){
> var foo
> var bar
> }
> <------------------- need this guy here</code></pre>
<h2 id="footnotes">Footnotes</h2>
<pre><code>I have more [^1] to say up here.
-- then somewhere else (like at the bottom of the page) ---
[^1]: To say down here.</code></pre>
<h2 id="lists">Lists</h2>
<p>Unordered</p>
<pre><code>* item 1
* item 2
* item3
-- or --
- item 1
- item 2
* mixed
* is
* fine
* too
- item 3</code></pre>
<p>Ordered</p>
<pre><code>1. item 1
2. item 2
3. item3
-- or (just as long as number-dot exists)--
1. item 1
1. item 2
1. item 3</code></pre>
<h2 id="preformatted">Preformatted</h2>
<pre><code> Begin line with 2 or more spaces or a tab.</code></pre>
<h2 id="code">Code</h2>
<p>Inline</p>
<pre><code>`This is code`</code></pre>
<p>Block</p>
<pre><code>```
This is too
```</code></pre>
<p>Syntax Highlighted</p>
<pre><code>```css
#button {
border: none;
}
```</code></pre>
<h2 id="definition-list">Definition List</h2>
<pre><code>Javascipt
: A relatively easy language to learn
Markdown
: Text-to-HTML conversion tool</code></pre>
<h2 id="abreviations">Abreviations</h2>
<pre><code>For example HTML stands for (hover over HTML)
-- then somewhere else (like at the bottom of the page) ---
*[HTML]: HyperText Markup Language</code></pre></div>
</div>
<div class="footer">Generated by <a href="http://www.documon.net" target="_blank">Documon</a></div>
</body>
</html>