408 lines
24 KiB
HTML
408 lines
24 KiB
HTML
|
<!DOCTYPE HTML>
|
|||
|
|
<html lang="en" class="light" dir="ltr">
|
|||
|
|
<head>
|
|||
|
|
<!-- Book generated using mdBook -->
|
|||
|
|
<meta charset="UTF-8">
|
|||
|
|
<title>Markdown - mdBook Documentation</title>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<!-- Custom HTML head -->
|
|||
|
|
|
|||
|
|
<meta name="description" content="Create book from markdown files. Like Gitbook but implemented in Rust">
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|||
|
|
<meta name="theme-color" content="#ffffff">
|
|||
|
|
|
|||
|
|
<link rel="icon" href="../favicon.svg">
|
|||
|
|
<link rel="shortcut icon" href="../favicon.png">
|
|||
|
|
<link rel="stylesheet" href="../css/variables.css">
|
|||
|
|
<link rel="stylesheet" href="../css/general.css">
|
|||
|
|
<link rel="stylesheet" href="../css/chrome.css">
|
|||
|
|
<link rel="stylesheet" href="../css/print.css" media="print">
|
|||
|
|
|
|||
|
|
<!-- Fonts -->
|
|||
|
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
|||
|
|
<link rel="stylesheet" href="../fonts/fonts.css">
|
|||
|
|
|
|||
|
|
<!-- Highlight.js Stylesheets -->
|
|||
|
|
<link rel="stylesheet" href="../highlight.css">
|
|||
|
|
<link rel="stylesheet" href="../tomorrow-night.css">
|
|||
|
|
<link rel="stylesheet" href="../ayu-highlight.css">
|
|||
|
|
|
|||
|
|
<!-- Custom theme stylesheets -->
|
|||
|
|
|
|||
|
|
<!-- MathJax -->
|
|||
|
|
<script async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
|||
|
|
</head>
|
|||
|
|
<body class="sidebar-visible no-js">
|
|||
|
|
<div id="body-container">
|
|||
|
|
<!-- Provide site root to javascript -->
|
|||
|
|
<script>
|
|||
|
|
var path_to_root = "../";
|
|||
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|||
|
|
<script>
|
|||
|
|
try {
|
|||
|
|
var theme = localStorage.getItem('mdbook-theme');
|
|||
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
|||
|
|
|
|||
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
|||
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
|||
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
|||
|
|
}
|
|||
|
|
} catch (e) { }
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
|||
|
|
<script>
|
|||
|
|
var theme;
|
|||
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|||
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|||
|
|
var html = document.querySelector('html');
|
|||
|
|
html.classList.remove('light')
|
|||
|
|
html.classList.add(theme);
|
|||
|
|
var body = document.querySelector('body');
|
|||
|
|
body.classList.remove('no-js')
|
|||
|
|
body.classList.add('js');
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
|||
|
|
|
|||
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|||
|
|
<script>
|
|||
|
|
var body = document.querySelector('body');
|
|||
|
|
var sidebar = null;
|
|||
|
|
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
|||
|
|
if (document.body.clientWidth >= 1080) {
|
|||
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|||
|
|
sidebar = sidebar || 'visible';
|
|||
|
|
} else {
|
|||
|
|
sidebar = 'hidden';
|
|||
|
|
}
|
|||
|
|
sidebar_toggle.checked = sidebar === 'visible';
|
|||
|
|
body.classList.remove('sidebar-visible');
|
|||
|
|
body.classList.add("sidebar-" + sidebar);
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|||
|
|
<div class="sidebar-scrollbox">
|
|||
|
|
<ol class="chapter"><li class="chapter-item expanded affix "><a href="../index.html">Introduction</a></li><li class="chapter-item expanded affix "><li class="part-title">User Guide</li><li class="chapter-item expanded "><a href="../guide/installation.html"><strong aria-hidden="true">1.</strong> Installation</a></li><li class="chapter-item expanded "><a href="../guide/reading.html"><strong aria-hidden="true">2.</strong> Reading Books</a></li><li class="chapter-item expanded "><a href="../guide/creating.html"><strong aria-hidden="true">3.</strong> Creating a Book</a></li><li class="chapter-item expanded affix "><li class="part-title">Reference Guide</li><li class="chapter-item expanded "><a href="../cli/index.html"><strong aria-hidden="true">4.</strong> Command Line Tool</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../cli/init.html"><strong aria-hidden="true">4.1.</strong> init</a></li><li class="chapter-item expanded "><a href="../cli/build.html"><strong aria-hidden="true">4.2.</strong> build</a></li><li class="chapter-item expanded "><a href="../cli/watch.html"><strong aria-hidden="true">4.3.</strong> watch</a></li><li class="chapter-item expanded "><a href="../cli/serve.html"><strong aria-hidden="true">4.4.</strong> serve</a></li><li class="chapter-item expanded "><a href="../cli/test.html"><strong aria-hidden="true">4.5.</strong> test</a></li><li class="chapter-item expanded "><a href="../cli/clean.html"><strong aria-hidden="true">4.6.</strong> clean</a></li><li class="chapter-item expanded "><a href="../cli/completions.html"><strong aria-hidden="true">4.7.</strong> completions</a></li></ol></li><li class="chapter-item expanded "><a href="../format/index.html"><strong aria-hidden="true">5.</strong> Format</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../format/summary.html"><strong aria-hidden="true">5.1.</strong> SUMMARY.md</a></li><li><ol class="section"><li class="chapter-item expanded "><div><strong aria-hidden="true">5.1.1.</strong> Draft chapter</div></li></ol></li><li class="chapter-item expanded "><a href="../format/configuration/index.html"><strong aria-hidden="true">5.2.</strong> Configuration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../format/configuration/general.html"><strong aria-hidden="true">5.2.1.</strong> General</a></li><li class="chapter-item expanded "><a href="../format/configuration/preprocessors.html"><strong aria-hidden="true">5.2.2.</strong> Preprocessors</a></li><li class="chapter-item expanded "><a href="../format/configuration/renderers.html"><strong aria-hidden="true">5.2.3.</strong> Renderers</a></li><li class="chapter-item expanded "><a href="../format/configuration/environment-variables.html"><strong aria-hidden="true">5.2.4.</strong> Environment Variables</a></li></ol></li><li class="chapter-item expanded "><a href="../format/theme/index.html"><strong aria-hidden="true">5.3.</strong> Theme</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../format/theme/index-hbs.html"><strong aria-hidden="true">5.3.1.</strong> index.hbs</a></li><li class="chapter-item expanded "><a href="../format/theme/syntax-highlighting.html"><strong aria-hidden="true">5.3.2.</strong> Syntax highlighting</a></li><li class="chapter-item expanded "><a href="../format/theme/editor.html"><strong aria-hidden="true">5.3.3.</strong> Editor</a></li></ol></li><li class="chapter-item expanded "><a href="../format/mathjax.html"><strong aria-hidden="true">5.4.</strong> MathJax Support</a></li><li class="chapter-item expanded "><a href="../format/mdbook.html"><strong aria-hidden="true">5.5.</strong> mdBook-specific features</a></li><li class="chapter-item expanded "><a href="../format/markdown.html" class="active"><strong aria-hidden="true">5.6.</strong> Markdown</a></li></ol></li><li class="chapter-item expanded "><a href="../continuous-integration.html"><strong aria-hidden="true">6.</strong> Continuous Integration</a></li><li class="chapter-item expanded "><a href="../for_developers/index
|
|||
|
|
</div>
|
|||
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
|||
|
|
<div class="sidebar-resize-indicator"></div>
|
|||
|
|
</div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<!-- Track and set sidebar scroll position -->
|
|||
|
|
<script>
|
|||
|
|
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
|
|||
|
|
sidebarScrollbox.addEventListener('click', function(e) {
|
|||
|
|
if (e.target.tagName === 'A') {
|
|||
|
|
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
|
|||
|
|
}
|
|||
|
|
}, { passive: true });
|
|||
|
|
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
|
|||
|
|
sessionStorage.removeItem('sidebar-scroll');
|
|||
|
|
if (sidebarScrollTop) {
|
|||
|
|
// preserve sidebar scroll position when navigating via links within sidebar
|
|||
|
|
sidebarScrollbox.scrollTop = sidebarScrollTop;
|
|||
|
|
} else {
|
|||
|
|
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
|
|||
|
|
var activeSection = document.querySelector('#sidebar .active');
|
|||
|
|
if (activeSection) {
|
|||
|
|
activeSection.scrollIntoView({ block: 'center' });
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
<div id="page-wrapper" class="page-wrapper">
|
|||
|
|
|
|||
|
|
<div class="page">
|
|||
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|||
|
|
<div id="menu-bar" class="menu-bar sticky">
|
|||
|
|
<div class="left-buttons">
|
|||
|
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|||
|
|
<i class="fa fa-bars"></i>
|
|||
|
|
</label>
|
|||
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
|||
|
|
<i class="fa fa-paint-brush"></i>
|
|||
|
|
</button>
|
|||
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
|||
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
|||
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
|||
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
|||
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
|||
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
|||
|
|
</ul>
|
|||
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
|||
|
|
<i class="fa fa-search"></i>
|
|||
|
|
</button>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<h1 class="menu-title">mdBook Documentation</h1>
|
|||
|
|
|
|||
|
|
<div class="right-buttons">
|
|||
|
|
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
|||
|
|
<i id="print-button" class="fa fa-print"></i>
|
|||
|
|
</a>
|
|||
|
|
<a href="https://github.com/rust-lang/mdBook/tree/master/guide" title="Git repository" aria-label="Git repository">
|
|||
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
|||
|
|
</a>
|
|||
|
|
<a href="https://github.com/rust-lang/mdBook/edit/master/guide/src/format/markdown.md" title="Suggest an edit" aria-label="Suggest an edit">
|
|||
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div id="search-wrapper" class="hidden">
|
|||
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|||
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
|||
|
|
</form>
|
|||
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
|||
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
|||
|
|
<ul id="searchresults">
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
|||
|
|
<script>
|
|||
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
|||
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
|||
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
|||
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
|||
|
|
});
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
<div id="content" class="content">
|
|||
|
|
<main>
|
|||
|
|
<h1 id="markdown"><a class="header" href="#markdown">Markdown</a></h1>
|
|||
|
|
<p>mdBook's <a href="https://github.com/raphlinus/pulldown-cmark">parser</a> adheres to the <a href="https://commonmark.org/">CommonMark</a> specification with some extensions described below.
|
|||
|
|
You can take a quick <a href="https://commonmark.org/help/tutorial/">tutorial</a>,
|
|||
|
|
or <a href="https://spec.commonmark.org/dingus/">try out</a> CommonMark in real time. A complete Markdown overview is out of scope for
|
|||
|
|
this documentation, but below is a high level overview of some of the basics. For a more in-depth experience, check out the
|
|||
|
|
<a href="https://www.markdownguide.org">Markdown Guide</a>.</p>
|
|||
|
|
<h2 id="text-and-paragraphs"><a class="header" href="#text-and-paragraphs">Text and Paragraphs</a></h2>
|
|||
|
|
<p>Text is rendered relatively predictably:</p>
|
|||
|
|
<pre><code class="language-markdown">Here is a line of text.
|
|||
|
|
|
|||
|
|
This is a new line.
|
|||
|
|
</code></pre>
|
|||
|
|
<p>Will look like you might expect:</p>
|
|||
|
|
<p>Here is a line of text.</p>
|
|||
|
|
<p>This is a new line.</p>
|
|||
|
|
<h2 id="headings"><a class="header" href="#headings">Headings</a></h2>
|
|||
|
|
<p>Headings use the <code>#</code> marker and should be on a line by themselves. More <code>#</code> mean smaller headings:</p>
|
|||
|
|
<pre><code class="language-markdown">### A heading
|
|||
|
|
|
|||
|
|
Some text.
|
|||
|
|
|
|||
|
|
#### A smaller heading
|
|||
|
|
|
|||
|
|
More text.
|
|||
|
|
</code></pre>
|
|||
|
|
<h3 id="a-heading"><a class="header" href="#a-heading">A heading</a></h3>
|
|||
|
|
<p>Some text.</p>
|
|||
|
|
<h4 id="a-smaller-heading"><a class="header" href="#a-smaller-heading">A smaller heading</a></h4>
|
|||
|
|
<p>More text.</p>
|
|||
|
|
<h2 id="lists"><a class="header" href="#lists">Lists</a></h2>
|
|||
|
|
<p>Lists can be unordered or ordered. Ordered lists will order automatically:</p>
|
|||
|
|
<pre><code class="language-markdown">* milk
|
|||
|
|
* eggs
|
|||
|
|
* butter
|
|||
|
|
|
|||
|
|
1. carrots
|
|||
|
|
1. celery
|
|||
|
|
1. radishes
|
|||
|
|
</code></pre>
|
|||
|
|
<ul>
|
|||
|
|
<li>milk</li>
|
|||
|
|
<li>eggs</li>
|
|||
|
|
<li>butter</li>
|
|||
|
|
</ul>
|
|||
|
|
<ol>
|
|||
|
|
<li>carrots</li>
|
|||
|
|
<li>celery</li>
|
|||
|
|
<li>radishes</li>
|
|||
|
|
</ol>
|
|||
|
|
<h2 id="links"><a class="header" href="#links">Links</a></h2>
|
|||
|
|
<p>Linking to a URL or local file is easy:</p>
|
|||
|
|
<pre><code class="language-markdown">Use [mdBook](https://github.com/rust-lang/mdBook).
|
|||
|
|
|
|||
|
|
Read about [mdBook](mdbook.md).
|
|||
|
|
|
|||
|
|
A bare url: <https://www.rust-lang.org>.
|
|||
|
|
</code></pre>
|
|||
|
|
<p>Use <a href="https://github.com/rust-lang/mdBook">mdBook</a>.</p>
|
|||
|
|
<p>Read about <a href="mdbook.html">mdBook</a>.</p>
|
|||
|
|
<p>A bare url: <a href="https://www.rust-lang.org">https://www.rust-lang.org</a>.</p>
|
|||
|
|
<hr />
|
|||
|
|
<p>Relative links that end with <code>.md</code> will be converted to the <code>.html</code> extension.
|
|||
|
|
It is recommended to use <code>.md</code> links when possible.
|
|||
|
|
This is useful when viewing the Markdown file outside of mdBook, for example on GitHub or GitLab which render Markdown automatically.</p>
|
|||
|
|
<p>Links to <code>README.md</code> will be converted to <code>index.html</code>.
|
|||
|
|
This is done since some services like GitHub render README files automatically, but web servers typically expect the root file to be called <code>index.html</code>.</p>
|
|||
|
|
<p>You can link to individual headings with <code>#</code> fragments.
|
|||
|
|
For example, <code>mdbook.md#text-and-paragraphs</code> would link to the <a href="#text-and-paragraphs">Text and Paragraphs</a> section above.
|
|||
|
|
The ID is created by transforming the heading such as converting to lowercase and replacing spaces with dashes.
|
|||
|
|
You can click on any heading and look at the URL in your browser to see what the fragment looks like.</p>
|
|||
|
|
<h2 id="images"><a class="header" href="#images">Images</a></h2>
|
|||
|
|
<p>Including images is simply a matter of including a link to them, much like in the <em>Links</em> section above. The following markdown
|
|||
|
|
includes the Rust logo SVG image found in the <code>images</code> directory at the same level as this file:</p>
|
|||
|
|
<pre><code class="language-markdown">
|
|||
|
|
</code></pre>
|
|||
|
|
<p>Produces the following HTML when built with mdBook:</p>
|
|||
|
|
<pre><code class="language-html"><p><img src="images/rust-logo-blk.svg" alt="The Rust Logo" /></p>
|
|||
|
|
</code></pre>
|
|||
|
|
<p>Which, of course displays the image like so:</p>
|
|||
|
|
<p><img src="images/rust-logo-blk.svg" alt="The Rust Logo" /></p>
|
|||
|
|
<h2 id="extensions"><a class="header" href="#extensions">Extensions</a></h2>
|
|||
|
|
<p>mdBook has several extensions beyond the standard CommonMark specification.</p>
|
|||
|
|
<h3 id="strikethrough"><a class="header" href="#strikethrough">Strikethrough</a></h3>
|
|||
|
|
<p>Text may be rendered with a horizontal line through the center by wrapping the
|
|||
|
|
text with one or two tilde characters on each side:</p>
|
|||
|
|
<pre><code class="language-text">An example of ~~strikethrough text~~.
|
|||
|
|
</code></pre>
|
|||
|
|
<p>This example will render as:</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<p>An example of <del>strikethrough text</del>.</p>
|
|||
|
|
</blockquote>
|
|||
|
|
<p>This follows the <a href="https://github.github.com/gfm/#strikethrough-extension-">GitHub Strikethrough extension</a>.</p>
|
|||
|
|
<h3 id="footnotes"><a class="header" href="#footnotes">Footnotes</a></h3>
|
|||
|
|
<p>A footnote generates a small numbered link in the text which when clicked
|
|||
|
|
takes the reader to the footnote text at the bottom of the item. The footnote
|
|||
|
|
label is written similarly to a link reference with a caret at the front. The
|
|||
|
|
footnote text is written like a link reference definition, with the text
|
|||
|
|
following the label. Example:</p>
|
|||
|
|
<pre><code class="language-text">This is an example of a footnote[^note].
|
|||
|
|
|
|||
|
|
[^note]: This text is the contents of the footnote, which will be rendered
|
|||
|
|
towards the bottom.
|
|||
|
|
</code></pre>
|
|||
|
|
<p>This example will render as:</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<p>This is an example of a footnote<sup class="footnote-reference"><a href="#note">1</a></sup>.</p>
|
|||
|
|
<div class="footnote-definition" id="note"><sup class="footnote-definition-label">1</sup>
|
|||
|
|
<p>This text is the contents of the footnote, which will be rendered
|
|||
|
|
towards the bottom.</p>
|
|||
|
|
</div>
|
|||
|
|
</blockquote>
|
|||
|
|
<p>The footnotes are automatically numbered based on the order the footnotes are
|
|||
|
|
written.</p>
|
|||
|
|
<h3 id="tables"><a class="header" href="#tables">Tables</a></h3>
|
|||
|
|
<p>Tables can be written using pipes and dashes to draw the rows and columns of
|
|||
|
|
the table. These will be translated to HTML table matching the shape. Example:</p>
|
|||
|
|
<pre><code class="language-text">| Header1 | Header2 |
|
|||
|
|
|---------|---------|
|
|||
|
|
| abc | def |
|
|||
|
|
</code></pre>
|
|||
|
|
<p>This example will render similarly to this:</p>
|
|||
|
|
<div class="table-wrapper"><table><thead><tr><th>Header1</th><th>Header2</th></tr></thead><tbody>
|
|||
|
|
<tr><td>abc</td><td>def</td></tr>
|
|||
|
|
</tbody></table>
|
|||
|
|
</div>
|
|||
|
|
<p>See the specification for the <a href="https://github.github.com/gfm/#tables-extension-">GitHub Tables extension</a> for more
|
|||
|
|
details on the exact syntax supported.</p>
|
|||
|
|
<h3 id="task-lists"><a class="header" href="#task-lists">Task lists</a></h3>
|
|||
|
|
<p>Task lists can be used as a checklist of items that have been completed.
|
|||
|
|
Example:</p>
|
|||
|
|
<pre><code class="language-md">- [x] Complete task
|
|||
|
|
- [ ] Incomplete task
|
|||
|
|
</code></pre>
|
|||
|
|
<p>This will render as:</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<ul>
|
|||
|
|
<li><input disabled="" type="checkbox" checked=""/>
|
|||
|
|
Complete task</li>
|
|||
|
|
<li><input disabled="" type="checkbox"/>
|
|||
|
|
Incomplete task</li>
|
|||
|
|
</ul>
|
|||
|
|
</blockquote>
|
|||
|
|
<p>See the specification for the <a href="https://github.github.com/gfm/#task-list-items-extension-">task list extension</a> for more details.</p>
|
|||
|
|
<h3 id="smart-punctuation"><a class="header" href="#smart-punctuation">Smart punctuation</a></h3>
|
|||
|
|
<p>Some ASCII punctuation sequences will be automatically turned into fancy Unicode
|
|||
|
|
characters:</p>
|
|||
|
|
<div class="table-wrapper"><table><thead><tr><th>ASCII sequence</th><th>Unicode</th></tr></thead><tbody>
|
|||
|
|
<tr><td><code>--</code></td><td>–</td></tr>
|
|||
|
|
<tr><td><code>---</code></td><td>—</td></tr>
|
|||
|
|
<tr><td><code>...</code></td><td>…</td></tr>
|
|||
|
|
<tr><td><code>"</code></td><td>“ or ”, depending on context</td></tr>
|
|||
|
|
<tr><td><code>'</code></td><td>‘ or ’, depending on context</td></tr>
|
|||
|
|
</tbody></table>
|
|||
|
|
</div>
|
|||
|
|
<p>So, no need to manually enter those Unicode characters!</p>
|
|||
|
|
<p>This feature is disabled by default.
|
|||
|
|
To enable it, see the <a href="configuration/renderers.html#html-renderer-options"><code>output.html.curly-quotes</code></a> config option.</p>
|
|||
|
|
<h3 id="heading-attributes"><a class="header" href="#heading-attributes">Heading attributes</a></h3>
|
|||
|
|
<p>Headings can have a custom HTML ID and classes. This lets you maintain the same ID even if you change the heading's text, it also lets you add multiple classes in the heading.</p>
|
|||
|
|
<p>Example:</p>
|
|||
|
|
<pre><code class="language-md"># Example heading { #first .class1 .class2 }
|
|||
|
|
</code></pre>
|
|||
|
|
<p>This makes the level 1 heading with the content <code>Example heading</code>, ID <code>first</code>, and classes <code>class1</code> and <code>class2</code>. Note that the attributes should be space-separated.</p>
|
|||
|
|
<p>More information can be found in the <a href="https://github.com/raphlinus/pulldown-cmark/blob/master/pulldown-cmark/specs/heading_attrs.txt">heading attrs spec page</a>.</p>
|
|||
|
|
|
|||
|
|
</main>
|
|||
|
|
|
|||
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|||
|
|
<!-- Mobile navigation buttons -->
|
|||
|
|
<a rel="prev" href="../format/mdbook.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|||
|
|
<i class="fa fa-angle-left"></i>
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
<a rel="next prefetch" href="../continuous-integration.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|||
|
|
<i class="fa fa-angle-right"></i>
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
<div style="clear: both"></div>
|
|||
|
|
</nav>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
|||
|
|
<a rel="prev" href="../format/mdbook.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|||
|
|
<i class="fa fa-angle-left"></i>
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
<a rel="next prefetch" href="../continuous-integration.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|||
|
|
<i class="fa fa-angle-right"></i>
|
|||
|
|
</a>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.playground_line_numbers = true;
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.playground_copyable = true;
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
<script src="../ace.js"></script>
|
|||
|
|
<script src="../editor.js"></script>
|
|||
|
|
<script src="../mode-rust.js"></script>
|
|||
|
|
<script src="../theme-dawn.js"></script>
|
|||
|
|
<script src="../theme-tomorrow_night.js"></script>
|
|||
|
|
|
|||
|
|
<script src="../elasticlunr.min.js"></script>
|
|||
|
|
<script src="../mark.min.js"></script>
|
|||
|
|
<script src="../searcher.js"></script>
|
|||
|
|
|
|||
|
|
<script src="../clipboard.min.js"></script>
|
|||
|
|
<script src="../highlight.js"></script>
|
|||
|
|
<script src="../book.js"></script>
|
|||
|
|
|
|||
|
|
<!-- Custom JS scripts -->
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</body>
|
|||
|
|
</html>
|