mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-03-28 17:42:47 +01:00
201 lines
7.3 KiB
HTML
201 lines
7.3 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">
|
|
<meta name="description" content="Starter template for a MkDocs docs site on GH Pages - including CI">
|
|
|
|
<link rel="canonical" href="https://michaelcurrin.github.io/mkdocs-quickstart/">
|
|
<link rel="shortcut icon" href="img/favicon.ico">
|
|
<title>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 = "Home";
|
|
var mkdocs_page_input_path = "index.md";
|
|
var mkdocs_page_url = "/mkdocs-quickstart/";
|
|
</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 class="current">
|
|
<li class="toctree-l1 current"><a class="reference internal current" href=".">Home</a>
|
|
<ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="#features">Features</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="about-mkdocs/">About MkDocs</a>
|
|
</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>Home</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
<a href="https://github.com/MichaelCurrin/mkdocs-quickstart/edit/master/docs/docs/index.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<hr/>
|
|
</div>
|
|
|
|
<div role="main">
|
|
<div class="section">
|
|
|
|
<h1 id="mkdocs-quickstart">MkDocs Quickstart</h1>
|
|
<blockquote>
|
|
<p>Started template for a MkDocs docs site on GH Pages - including CI </p>
|
|
</blockquote>
|
|
<p><a href="https://github.com/MichaelCurrin/mkdocs-quickstart"><img alt="Repo stars" src="https://img.shields.io/github/stars/MichaelCurrin/mkdocs-quickstart?style=social" /></a></p>
|
|
<p>Use the MkDocs (<em>make docs</em>) tool to create build a docs site around markdown docs.</p>
|
|
<p>Follow the tutorial to add an existing project or create a project from scratch. The result will look like this project.</p>
|
|
<h2 id="features">Features</h2>
|
|
<blockquote>
|
|
<p>How to use this project</p>
|
|
</blockquote>
|
|
<ul>
|
|
<li><strong>Follow the tutorial instructions</strong><ul>
|
|
<li>Install and configure a new or existing project.</li>
|
|
<li>Run it locally.</li>
|
|
<li>Deploy it.</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong>Add a copy of this project to your repos</strong><ul>
|
|
<li><a href="https://github.com/MichaelCurrin/mkdocs-quickstart/generate"><img alt="Use this template" src="https://img.shields.io/badge/Use_this_template-2ea44f?logo=github" /></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><strong>View the live demo</strong><ul>
|
|
<li>This site is hosted on GitHub Pages. See if you like it. Other themes are available - see the tutorial.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<p>The aim here is not be complete or explain all concepts. It is to provide a reference for common steps and choices needed when setting up a docs site, but still at a beginner-friendly level.</p>
|
|
<p>This guide is based on the <a href="https://www.mkdocs.org/">mkdocs.org</a> tutorial.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="about-mkdocs/" class="btn btn-neutral float-right" title="About MkDocs">Next <span class="icon icon-circle-arrow-right"></span></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="about-mkdocs/" 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>
|
|
|
|
<!--
|
|
MkDocs version : 1.2.2
|
|
Build Date UTC : 2021-07-28 11:07:01.106767+00:00
|
|
-->
|