centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity

Deployed 40e7bb0 with MkDocs version: 0.14.0

Browse Source
This commit is contained in:
Dougal Matthews
2015-06-09 09:51:16 +00:00
parent 4c82346e4b
commit ab0602ce0c
16 changed files with 110 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
.nojekyll Normal file
View File

0
__init__.py Normal file
View File

8
about/contributing/index.html
View File

@@ -207,26 +207,26 @@ traceback.</p>
MkDocs you can do so with the following command. This can be useful if you
want to provide feedback for a new feature or want to confirm if a bug you
have encountered is fixed in the git master. It is <strong>strongly</strong> recommended
that you do this within a <a href="../virtualenv">virtualenv</a>.</p>
that you do this within a <a href="https://virtualenv.pypa.io/en/latest/userguide.html">virtualenv</a>.</p>
<pre><code class="bash">pip install https://github.com/mkdocs/mkdocs/archive/master.tar.gz
</code></pre>
<h2 id="installing-for-development">Installing for Development<a class="headerlink" href="#installing-for-development" title="Permanent link"></a></h2>
<p>First you'll need to fork and clone the repository. Once you have a local
copy, run the following command. It is <strong>strongly</strong> recommended that you do
this within a <a href="../virtualenv">virtualenv</a>.</p>
this within a <a href="https://virtualenv.pypa.io/en/latest/userguide.html">virtualenv</a>.</p>
<pre><code class="bash">pip install --editable .
</code></pre>
<p>This will install MkDocs in development mode which binds the <code>mkdocs</code> command
to the git repository.</p>
<h2 id="running-the-tests">Running the tests<a class="headerlink" href="#running-the-tests" title="Permanent link"></a></h2>
<p>To run the tests, it is recommended that you use <a href="../tox">Tox</a>. This just needs
<p>To run the tests, it is recommended that you use <a href="https://tox.readthedocs.org/en/latest/">Tox</a>. This just needs
to be pip installed and then the test suite can be ran for MkDocs but running
the command <code>tox</code> in the root of your MkDocs repository.</p>
<p>It will attempt to run the tests against all of the Python versions we
support. So don't be concerned if you are missing some and they fail. The rest
will be verified by <a href="../travis">Travis</a> when you submit a pull request.</p>
will be verified by <a href="https://travis-ci.org/repositories">Travis</a> when you submit a pull request.</p>
<h2 id="submitting-pull-requests">Submitting Pull Requests<a class="headerlink" href="#submitting-pull-requests" title="Permanent link"></a></h2>
<p>Once you are happy with your changes or you are ready for some feedback, push
it to your fork and send a pull request. For a change to be accepted it will

33
about/release-notes/index.html
View File

@@ -174,6 +174,10 @@
<li><a href="#upgrading">Upgrading</a></li>
<li><a href="#version-0140-2015-06-09">Version 0.14.0 (2015-06-09)</a></li>
<li><a href="#version-0133-2015-06-02">Version 0.13.3 (2015-06-02)</a></li>
<li><a href="#version-0132-2015-05-30">Version 0.13.2 (2015-05-30)</a></li>
<li><a href="#version-0131-2015-05-27">Version 0.13.1 (2015-05-27)</a></li>
@@ -205,8 +209,33 @@
</code></pre>
<p>You can determine your currently installed version using <code>mkdocs --version</code>:</p>
<pre><code>$ mkdocs --version
mkdocs, version 0.13.0
mkdocs, version 0.14.0
</code></pre>
<h2 id="version-0140-2015-06-09">Version 0.14.0 (2015-06-09)<a class="headerlink" href="#version-0140-2015-06-09" title="Permanent link"></a></h2>
<ul>
<li>Improve Unicode handling by ensuring that all config strings are loaded as
Unicode. (#592)</li>
<li>Remove dependancy on the six library. (#583)</li>
<li>Remove dependancy on the ghp-import library. (#547)</li>
<li>Add <code>--quiet</code> and <code>--verbose</code> options to all subcommands. (#579)</li>
<li>Add short options (<code>-a</code>) to most command line options. (#579)</li>
<li>Add copyright footer for readthedocs theme. (#568)</li>
<li>If the requested port in <code>mkdocs serve</code> is already in use, don't show the
user a full stack trace. (#596)</li>
<li>Bugfix: Fix a JavaScript encoding problem when searching with spaces. (#586)</li>
<li>Bugfix: gh-deploy now works if the mkdocs.yml is not in the git repo root.
(#578)</li>
<li>Bugfix: Handle (pass-through instead of dropping) HTML entities while
parsing TOC. (#612)</li>
<li>Bugfix: Default extra_templates to an empty list, don't automatically
discover them. (#616)</li>
</ul>
<h2 id="version-0133-2015-06-02">Version 0.13.3 (2015-06-02)<a class="headerlink" href="#version-0133-2015-06-02" title="Permanent link"></a></h2>
<ul>
<li>Bugfix: Reduce validation error to a warning if the site_dir is within
the docs_dir as this shouldn't cause any problems with building but will
inconvenience users building multiple times. (#580)</li>
</ul>
<h2 id="version-0132-2015-05-30">Version 0.13.2 (2015-05-30)<a class="headerlink" href="#version-0132-2015-05-30" title="Permanent link"></a></h2>
<ul>
<li>Bugfix: Ensure all errors and warnings are logged before exiting. (#536)</li>
@@ -215,7 +244,7 @@ mkdocs, version 0.13.0
<h2 id="version-0131-2015-05-27">Version 0.13.1 (2015-05-27)<a class="headerlink" href="#version-0131-2015-05-27" title="Permanent link"></a></h2>
<ul>
<li>Bugfix: Fix a problem with minimal configurations which only contain a list
of paths in the pages config (#562)</li>
of paths in the pages config. (#562)</li>
</ul>
<h2 id="version-0130-2015-05-26">Version 0.13.0 (2015-05-26)<a class="headerlink" href="#version-0130-2015-05-26" title="Permanent link"></a></h2>
<h3 id="deprecations">Deprecations<a class="headerlink" href="#deprecations" title="Permanent link"></a></h3>

0
fonts/fontawesome-webfont.eot Normal file → Executable file
View File

0
fonts/fontawesome-webfont.svg Normal file → Executable file
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 197 KiB

After

Width:  |  Height:  |  Size: 197 KiB

0
fonts/fontawesome-webfont.ttf Normal file → Executable file
View File

0
fonts/fontawesome-webfont.woff Normal file → Executable file
View File

16
index.html
View File

@@ -234,20 +234,20 @@ mkdocs [help|new|build|serve|gh-deploy] {options}
$ cd my-project
</code></pre>
<p>Let's take a moment to review the initial project that's been created for us.</p>
<p><img alt="The initial MkDocs layout" src="../img/initial-layout.png" /></p>
<p><img alt="The initial MkDocs layout" src="./img/initial-layout.png" /></p>
<p>There's a single configuration file named <code>mkdocs.yml</code>, and a folder named <code>docs</code> that will contain our documentation source files. Right now the <code>docs</code> folder just contains a single documentation page, named <code>index.md</code>.</p>
<p>MkDocs comes with a built-in webserver that lets you preview your documentation as you work on it. We start the webserver by making sure we're in the same directory as the <code>mkdocs.yml</code> config file, and then running the <code>mkdocs serve</code> command:</p>
<pre><code>$ mkdocs serve
Running at: http://127.0.0.1:8000/
</code></pre>
<p>Open up <a href="http://127.0.0.1:8000/">http://127.0.0.1:8000/</a> in your browser, and you'll see the index page being displayed:</p>
<p><img alt="The MkDocs live server" src="../img/screenshot.png" /></p>
<p><img alt="The MkDocs live server" src="./img/screenshot.png" /></p>
<p>The webserver also supports auto-reloading, and will rebuild your documentation whenever anything in the configuration file, documentation directory or theme directory changes.</p>
<p>Go ahead and edit the <code>docs/index.md</code> file now and save the file. Then simply hit reload in the browser and you'll see your updated documentation.</p>
<p>Now's also a good time to edit the configuration file, <code>mkdocs.yml</code>. Change the <code>site_name</code> setting to something else and save the file.</p>
<p><img alt="Editing the config file" src="../img/initial-config.png" /></p>
<p><img alt="Editing the config file" src="./img/initial-config.png" /></p>
<p>Once you hit reload in the browser you'll see your new site name take effect.</p>
<p><img alt="The site_name setting" src="../img/site-name.png" /></p>
<p><img alt="The site_name setting" src="./img/site-name.png" /></p>
<h2 id="adding-pages">Adding pages<a class="headerlink" href="#adding-pages" title="Permanent link"></a></h2>
<p>Go ahead and edit the <code>doc/index.md</code> document, and change the initial heading to <code>MkLorum</code>, then reload the site in your browser, and you should see the change take effect immediately.</p>
<p>Let's also add a second page to our documentation:</p>
@@ -269,7 +269,7 @@ pages:
theme: readthedocs
</code></pre>
<p>Refresh the browser again, and you'll now see the ReadTheDocs theme being used.</p>
<p><img alt="Screenshot" src="../img/readthedocs.png" /></p>
<p><img alt="Screenshot" src="./img/readthedocs.png" /></p>
<h2 id="building-the-site">Building the site<a class="headerlink" href="#building-the-site" title="Permanent link"></a></h2>
<p>That's looking good. We're ready to deploy the first pass of our <code>MkLorum</code> documentation now. Let's build the documentation.</p>
<pre><code>$ mkdocs build
@@ -291,7 +291,7 @@ about css fonts img index.html js
able to host it from pretty much anywhere. <a href="https://help.github.com/articles/creating-project-pages-manually">GitHub project pages</a> and <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Amazon
S3</a> are good hosting options. Upload the contents of the entire <code>site</code> directory
to wherever you're hosting your website from and you're done. For specific instructions
for a number of common hosts, see the <a href="../user-guide/deploying-your-docs/">Deploying your Docs</a> page.</p>
for a number of common hosts, see the <a href="./user-guide/deploying-your-docs/">Deploying your Docs</a> page.</p>
<h2 id="getting-help">Getting help<a class="headerlink" href="#getting-help" title="Permanent link"></a></h2>
<p>To get help with MkDocs, please use the <a href="https://groups.google.com/forum/#!forum/mkdocs">discussion group</a>, <a href="https://github.com/mkdocs/mkdocs/issues">GitHub issues</a> or the MkDocs IRC channel <code>#mkdocs</code> on freenode.</p></div>
@@ -341,6 +341,6 @@ for a number of common hosts, see the <a href="../user-guide/deploying-your-docs
</html>
<!--
MkDocs version : 0.13.2
Build Date UTC : 2015-05-31 18:01:31.832751
MkDocs version : 0.14.0
Build Date UTC : 2015-06-09 09:51:15.894252
-->

2
mkdocs/js/search.js
View File

@@ -15,7 +15,7 @@ require([
var sParameterName = sURLVariables[i].split('=');
if (sParameterName[0] == 'q')
{
return sParameterName[1];
return decodeURIComponent(sParameterName[1].replace(/\+/g, '%20'));
}
}
}

40
mkdocs/search_index.json
View File

File diff suppressed because one or more lines are too long

16
sitemap.xml
View File

@@ -4,7 +4,7 @@
<url>
<loc>http://www.mkdocs.org/</loc>
<lastmod>2015-05-31</lastmod>
<lastmod>2015-06-09</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -13,25 +13,25 @@
<url>
<loc>http://www.mkdocs.org/user-guide/configuration/</loc>
<lastmod>2015-05-31</lastmod>
<lastmod>2015-06-09</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.mkdocs.org/user-guide/deploying-your-docs/</loc>
<lastmod>2015-05-31</lastmod>
<lastmod>2015-06-09</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.mkdocs.org/user-guide/styling-your-docs/</loc>
<lastmod>2015-05-31</lastmod>
<lastmod>2015-06-09</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.mkdocs.org/user-guide/writing-your-docs/</loc>
<lastmod>2015-05-31</lastmod>
<lastmod>2015-06-09</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -41,19 +41,19 @@
<url>
<loc>http://www.mkdocs.org/about/contributing/</loc>
<lastmod>2015-05-31</lastmod>
<lastmod>2015-06-09</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.mkdocs.org/about/license/</loc>
<lastmod>2015-05-31</lastmod>
<lastmod>2015-06-09</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.mkdocs.org/about/release-notes/</loc>
<lastmod>2015-05-31</lastmod>
<lastmod>2015-06-09</lastmod>
<changefreq>daily</changefreq>
</url>

27
user-guide/configuration/index.html
View File

@@ -234,30 +234,20 @@
<p><strong>default</strong>: <code>null</code></p>
<h3 id="remote_branch">remote_branch<a class="headerlink" href="#remote_branch" title="Permanent link"></a></h3>
<p>Set the remote branch to commit to when using <code>gh-deploy</code> to update Github Pages. This option can be overriden by a commandline option in <code>gh-deploy</code>.</p>
<p>Set the remote branch to commit to when using <code>gh-deploy</code> to deploy to Github Pages. This option can be overridden by a command line option in <code>gh-deploy</code>.</p>
<p><strong>default</strong>: <code>gh-pages</code></p>
<h3 id="remote_name">remote_name<a class="headerlink" href="#remote_name" title="Permanent link"></a></h3>
<p>Set the remote name to push to when using <code>gh-deploy</code> to deploy to Github Pages. This option can be overridden by a command line option in <code>gh-deploy</code>.</p>
<p><strong>default</strong>: <code>gh-pages</code></p>
<h2 id="documentation-layout">Documentation layout<a class="headerlink" href="#documentation-layout" title="Permanent link"></a></h2>
<h3 id="pages">pages<a class="headerlink" href="#pages" title="Permanent link"></a></h3>
<p>This is setting is used to determine the set of pages that should be built for the documentation.</p>
<p>The setting should be a list. Each row in the list represents information about a single page as a list of strings. The first string represents the path of the documentation source file, and should be relative to the <code>docs_dir</code> setting. Remaining strings represent the title of the page in the site navigation.</p>
<p>Here's a simple example that would cause the build stage to create three pages:</p>
<p>This setting is used to determine the set of pages that should be built for the documentation. For example, the following would create Introduction, User Guide and About pages, given the three source files <code>index.md</code>, <code>user-guide.md</code> and <code>about.md</code>, respectively.</p>
<pre><code>pages:
- 'Introduction': 'index.md'
- 'User Guide': 'user-guide.md'
- 'Abut': 'about.md'
- 'About': 'about.md'
</code></pre>
<p>Assuming the <code>docs_dir</code> setting was left with the default value of <code>docs</code>, the source files for this site's build process would be <code>docs/index.md</code>, <code>docs/user-guide.md</code> and <code>docs/about.md</code>.</p>
<p>If you have a lot of project documentation you might choose to use headings to break up your site navigation by category. You can do so by including an extra string in the page configuration for any pages that require a navigation heading, like so:</p>
<pre><code>pages:
- Introduction: 'index.md'
- User Guide:
- 'Creating a new Marshmallow project': 'user-guide/creating.md'
- 'Marshmallow API guide': 'user-guide/api.md'
- 'Configuring Marshmallow': 'user-guide/configuration.md'
- About:
- License: 'about/license.md'
</code></pre>
<p>See also the section on <a href="../../user-guide/writing-your-docs/#configure-pages-and-navigation">configuring pages and navigation</a> for a more detailed breakdown.</p>
<p>See the section on <a href="../../user-guide/writing-your-docs/#configure-pages-and-navigation">configuring pages and navigation</a> for a more detailed breakdown, including how to create sub-sections.</p>
<h2 id="build-directories">Build directories<a class="headerlink" href="#build-directories" title="Permanent link"></a></h2>
<h3 id="theme">theme<a class="headerlink" href="#theme" title="Permanent link"></a></h3>
<p>Sets the theme of your documentation site, for a list of available themes visit
@@ -290,6 +280,9 @@ documentation on how to ignore specific directories.</p>
<h3 id="extra_javascript">extra_javascript<a class="headerlink" href="#extra_javascript" title="Permanent link"></a></h3>
<p>Set a list of JavaScript files to be included by the theme.</p>
<p><strong>default</strong>: By default <code>extra_javascript</code> will contain a list of all the JavaScript files found within the <code>docs_dir</code>, if none are found it will be <code>[]</code> (an empty list).</p>
<h3 id="extra_templates">extra_templates<a class="headerlink" href="#extra_templates" title="Permanent link"></a></h3>
<p>Set a list of templates to be built by MkDocs. To see more about writing templates for MkDocs read the documentation about <a href="../../user-guide/styling-your-docs/#custom-themes">custom themes</a> and specifically the section about the <a href="../../user-guide/styling-your-docs/#global-context">variables that are available</a> to templates.</p>
<p><strong>default</strong>: Unlike extra_css and extra_javascript, by default <code>extra_templates</code> will be <code>[]</code> (an empty list).</p>
<h3 id="extra">extra<a class="headerlink" href="#extra" title="Permanent link"></a></h3>
<p>A set of key value pairs, where the values can be any valid YAML construct, that will be passed to the template. This allows for great flexibility when creating custom themes.</p>
<p><strong>default</strong>: By default <code>extra</code> will be an empty key value mapping.</p>

6
user-guide/deploying-your-docs/index.html
View File

@@ -221,7 +221,7 @@ public repository.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>To benefit from all of the <a href="http://read-the-docs.readthedocs.org/en/latest/features.html">features</a> offered by Read the Docs, you will need
to use the <a href="http://127.0.0.1:8000/user-guide/styling-your-docs/#read-the-docs">Read the Docs theme</a> which ships with MkDocs. The various
to use the <a href="../../user-guide/styling-your-docs/">Read the Docs theme</a> which ships with MkDocs. The various
themes which may be referenced in Read the Docs' documentation are Sphinx
specific themes and will not work with MkDocs.</p>
</div>
@@ -231,7 +231,7 @@ Index</a> (PyPI), you can use the hosting provided at <a href="http://pythonhost
host documentation for your project. Run the following commands from your
project's root directory to upload your documentation:</p>
<pre><code class="sh">mkdocs build --clean
python setup.py upload_docs --upload-dir=site
python setup.py upload_docs --upload-dir=site
</code></pre>
<p>You documentation will be hosted at <code>http://pythonhosted.org/&lt;projectname&gt;/</code>
@@ -269,7 +269,7 @@ scp -r ./site usr@host:/path/to/server/root
<p>Of course, you will need to replace <code>user</code> with the username you have with your
hosting provider and <code>host</code> with the appropriate domain name. Additionally, you
will need to adjust the <code>/path/to/server/root</code> to match the configuration of
your hosts' file system. </p>
your hosts' file system.</p>
<p>See your host's documentation for specifics. You will likely want to search
their documentation for "ftp" or "uploading site".</p></div>

18
user-guide/styling-your-docs/index.html
View File

@@ -392,7 +392,23 @@ custom_theme/
</code></pre>
<h5 id="meta">meta<a class="headerlink" href="#meta" title="Permanent link"></a></h5>
<p>A mapping of the metadata included at the top of the markdown page.</p>
<p>A mapping of the metadata included at the top of the markdown page. In this example we define a <code>source</code> property above the page title.</p>
<pre><code class="no-highlight">source: generics.py
mixins.py
# Page title
Content...
</code></pre>
<p>A template can access this metadata for the page with the <code>meta.source</code> variable. This could then be used to link to source files related to the documentation page.</p>
<pre><code>{% for filename in meta.source %}
&lt;a class=&quot;github&quot; href=&quot;https://github.com/.../{{ filename }}&quot;&gt;
&lt;span class=&quot;label label-info&quot;&gt;{{ filename }}&lt;/span&gt;
&lt;/a&gt;
{% endfor %}
</code></pre>
<h5 id="canonical_url">canonical_url<a class="headerlink" href="#canonical_url" title="Permanent link"></a></h5>
<p>The full, canonical URL to the current page. This includes the site_url from the configuration.</p>
<h5 id="current_page">current_page<a class="headerlink" href="#current_page" title="Permanent link"></a></h5>

34
user-guide/writing-your-docs/index.html
View File

@@ -197,13 +197,13 @@
- 'index.md'
- 'about.md'
</code></pre>
<p>With this example we will build two pages at the top level and they will automatically have their titles inferred from the filename. To provide a custom name for these pages, they can be added before the filename.</p>
<p>With this example we will build two pages at the top level and they will automatically have their titles inferred from the filename. Assuming <code>docs_dir</code> has the default value, <code>docs</code>, the source files for this documentation would be <code>docs/index.md</code> and <code>docs/about.md</code>. To provide a custom name for these pages, they can be added before the filename.</p>
<pre><code>pages:
- Home: 'index.md'
- About: 'about.md'
</code></pre>
<h3 id="multilevel-documentation">Multilevel documentation<a class="headerlink" href="#multilevel-documentation" title="Permanent link"></a></h3>
<p>To create a second level in the navigation and group topics, the category can be provided before the page title. This is best demonstrated in a documentation project with more pages and is slightly more complicated.</p>
<p>Subsections can be created by listing related pages together under a section title. For example:</p>
<pre><code>pages:
- Home: 'index.md'
- User Guide:
@@ -213,7 +213,7 @@
- 'License': 'about/license.md'
- 'Release Notes': 'about/release-notes.md'
</code></pre>
<p>With the above configuration we have three top level sections Home, User Guide and About. Then under User Guide we have two pages, Writing your docs and Styling your docs. Under the About section we also have two pages, License and Release Notes</p>
<p>With the above configuration we have three top level sections: Home, User Guide and About. Then under User Guide we have two pages, Writing your docs and Styling your docs. Under the About section we also have two pages, License and Release Notes.</p>
<p><em>Note:</em> At present MkDocs only supports a second level of navigation.</p>
<h2 id="file-layout">File layout<a class="headerlink" href="#file-layout" title="Permanent link"></a></h2>
<p>Your documentation source should be written as regular Markdown files, and placed in a directory somewhere in your project. Normally this directory will be named <code>docs</code> and will exist at the top level of your project, alongside the <code>mkdocs.yml</code> configuration file.</p>
@@ -263,18 +263,6 @@ Given the above layout, pages would be generated for the following URLs:</p>
<p>You can also link to a section within a target documentation page by using an anchor link. The generated HTML will correctly transform the path portion of the hyperlink, and leave the anchor portion intact.</p>
<pre><code>Please see the [project license](about.md#license) for further details.
</code></pre>
<!--
#### Cross-referencing your documentation
Ex eam quem facilisi deserunt. Veri audiam audire id his, quo at aperiri moderatius. In admodum partiendo est, ei rebum minimum eam, singulis accusata delicatissimi eos ut. Imperdiet vulputate assueverit eos an, elit recusabo et usu. Eam ad euismod accusata vituperata. Oratio vocent nominavi ei eum.
At mel verear persius torquatos, his dolores [Sensibus](ref:) id, alia urbanitas in usu.
Eam ad euismod accusata vituperata. Oratio vocent nominavi ei eum.
Ne his mucius oporteat, [mea ut eros delicatissimi](ref:delicatissimi), iudico nonumes moderatius an mel.
-->
<h2 id="images-and-media">Images and media<a class="headerlink" href="#images-and-media" title="Permanent link"></a></h2>
<p>As well as the Markdown source files, you can also include other file types in your documentation, which will be copied across when generating your documentation site. These might include images and other media.</p>
<p>For example, if your project documentation needed to include a <a href="https://help.github.com/articles/setting-up-a-custom-domain-with-pages#setting-the-domain-in-your-repo">GitHub pages CNAME file</a> and a PNG formatted screenshot image then your file layout might look as follows:</p>
@@ -297,22 +285,6 @@ docs/
<p>You image will now be embedded when you build the documentation, and should also be previewed if you're working on the documentation with a Markdown editor.</p>
<h2 id="markdown-extensions">Markdown extensions<a class="headerlink" href="#markdown-extensions" title="Permanent link"></a></h2>
<p>MkDocs supports the following Markdown extensions.</p>
<!--
#### Page metadata
Unum errem propriae vis cu, et deseruisse interpretaris eam. Illum graecis per an, ludus laoreet repudiare nec an, molestie recteque et eam. Purto duis rationibus id eum, pro et amet appetere referrentur, minim impedit ad ius. Et nostrud perfecto sapientem vix, et dicit impedit consequat vim. Vis liber blandit no.
At mel verear persius torquatos, his dolores sensibus id, alia urbanitas in usu. Te pri cibo blandit. Debet dolore periculis ei pro, eu vis vidit ignota, vim natum dicta cu. Et appareat delicata vix, mei at solum lorem quodsi, verterem electram sit eu. Eius malis cum an, pro malorum euripidis ad, oblique appetere est cu. Eos ei fugit deterruisset. Vix ei aliquip dolorem, usu te euripidis reformidans, volumus pertinacia ea eam.
page_title: Lorum
page_description: "lorum ipsum dolor"
source_files: example.js, lorum.js
# Lorum Ipsum
Unum errem propriae vis cu, et deseruisse interpretaris eam. Illum graecis per an, ludus laoreet repudiare nec an, molestie recteque et eam.
-->
<h4 id="tables">Tables<a class="headerlink" href="#tables" title="Permanent link"></a></h4>
<p>A simple table looks like this:</p>
<pre><code class="text">First Header | Second Header | Third Header