mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-03-28 17:42:47 +01:00
213 lines
8.1 KiB
HTML
213 lines
8.1 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
|
<link rel="canonical" href="https://michaelcurrin.github.io/mkdocs-quickstart/about-mkdocs/">
|
|
<link rel="shortcut icon" href="../img/favicon.ico">
|
|
<title>About MkDocs - MkDocs Quickstart</title>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700" />
|
|
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "About MkDocs";
|
|
var mkdocs_page_input_path = "about-mkdocs.md";
|
|
var mkdocs_page_url = "/mkdocs-quickstart/about-mkdocs/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-2.1.1.min.js" defer></script>
|
|
<script src="../js/modernizr-2.8.3.min.js" defer></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> MkDocs Quickstart</a>
|
|
<div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">About MkDocs</a>
|
|
<ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="#what-is-mkdocs">What is MkDocs?</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#resources">Resources</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#reasons-to-use-mkdocs">Reasons to use MkDocs</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#do-i-need-to-know-python">Do I need to know Python?</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Tutorial</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../tutorial/tldr/">TL;DR</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../tutorial/installation/">Installation</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../tutorial/setup-project/">Set up project</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../tutorial/advanced/">Advanced</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../tutorial/usage/">Usage</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../tutorial/deploy/">Deploy</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">MkDocs Quickstart</a>
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="..">Docs</a> »</li>
|
|
|
|
|
|
|
|
<li>About MkDocs</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
<a href="https://github.com/MichaelCurrin/mkdocs-quickstart/edit/master/docs/docs/about-mkdocs.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<hr/>
|
|
</div>
|
|
|
|
<div role="main">
|
|
<div class="section">
|
|
|
|
<h1 id="about-mkdocs">About MkDocs</h1>
|
|
<h2 id="what-is-mkdocs">What is MkDocs?</h2>
|
|
<p>The description on the MkDocs site is:</p>
|
|
<blockquote>
|
|
<p>Project documentation with Markdown.</p>
|
|
</blockquote>
|
|
<p>MkDocs is a Python tool that generates a static site based on content written in Markdown.</p>
|
|
<p>If you are new to markdown, see the <a href="https://www.markdownguide.org/getting-started/">Getting Started</a> page on the Markdown Guide website.</p>
|
|
<h2 id="resources">Resources</h2>
|
|
<ul>
|
|
<li><a href="https://www.mkdocs.org">mkdocs.org</a> homepage</li>
|
|
<li><a href="https://github.com/mkdocs/mkdocs">mkdocs/mkdocs <img alt="Repo stars" src="https://img.shields.io/github/stars/mkdocs/mkdocs?style=social" /></a></li>
|
|
<li><a href="https://github.com/mkdocs/mkdocs/wiki">MkDocs Wiki</a> - covering themes, plugins, recipes and more.</li>
|
|
<li><a href="https://www.mkdocs.org/about/release-notes/">Release notes</a> for MkDocs.</li>
|
|
</ul>
|
|
<h2 id="reasons-to-use-mkdocs">Reasons to use MkDocs</h2>
|
|
<ul>
|
|
<li>Create an elegant, modern docs site for your project.</li>
|
|
<li>Create a static site and serve from GitHub Pages easily.</li>
|
|
<li>Low-code solution<ul>
|
|
<li>No need to write HTML or learn templating syntax needed</li>
|
|
<li>Use your existing markdown files as content.</li>
|
|
<li>Configure with a simple YAML file.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Customizable.<ul>
|
|
<li>Add custom HTML if you want.</li>
|
|
<li>Plugins available.</li>
|
|
<li>Flexible theme choices.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Includes search by default.</li>
|
|
<li>Broken links to files (including from your navbar) will be detected at build time and shown as warnings.</li>
|
|
</ul>
|
|
<h2 id="do-i-need-to-know-python">Do I need to know Python?</h2>
|
|
<p>MkDocs is built in Python (like Sphinx), but you don't have to write Python code. If you set up a <a href="deploy">Deploy</a> flow right, you don't even have to set it up locally, though then you can't preview.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="../tutorial/tldr/" class="btn btn-neutral float-right" title="TL;DR">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href=".." class="btn btn-neutral" title="Home"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" aria-label="versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/MichaelCurrin/mkdocs-quickstart/" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href=".." style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../tutorial/tldr/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|