Skip to content

Commit

Permalink
siteupdate
Browse files Browse the repository at this point in the history
  • Loading branch information
@Tpj-root
Tpj-root committed Oct 16, 2024
1 parent 3177f38 commit 81f6006
Show file tree
Hide file tree
Showing 51 changed files with 8,522 additions and 532 deletions.
128 changes: 128 additions & 0 deletions docs/404.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<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="shortcut icon" href="/LinuxCNC_HowItWorks/img/favicon.ico" />
<title>LinuxCNC_HowItWorks</title>
<link rel="stylesheet" href="/LinuxCNC_HowItWorks/css/theme.css" />
<link rel="stylesheet" href="/LinuxCNC_HowItWorks/css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />

<!--[if lt IE 9]>
<script src="/LinuxCNC_HowItWorks/js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</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="/LinuxCNC_HowItWorks/." class="icon icon-home"> LinuxCNC_HowItWorks
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="/LinuxCNC_HowItWorks//search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
</form>
</div>
</div>

<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="/LinuxCNC_HowItWorks/.">Home</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/LinuxCNC_HowItWorks/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="/LinuxCNC_HowItWorks/tutorial/tldr/">TL;DR</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/LinuxCNC_HowItWorks/tutorial/installation/">Installation</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/LinuxCNC_HowItWorks/tutorial/setup-project/">Set up project</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/LinuxCNC_HowItWorks/tutorial/advanced/">Advanced</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/LinuxCNC_HowItWorks/tutorial/usage/">Usage</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/LinuxCNC_HowItWorks/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="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="/LinuxCNC_HowItWorks/.">LinuxCNC_HowItWorks</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="/LinuxCNC_HowItWorks/." class="icon icon-home" aria-label="Docs"></a></li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">


<h1 id="404-page-not-found">404</h1>

<p><strong>Page not found</strong></p>


</div>
</div><footer>

<hr/>

<div role="contentinfo">
<!-- Copyright etc -->
</div>

Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/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/Tpj-root/LinuxCNC_HowItWorks" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>



</span>
</div>
<script src="/LinuxCNC_HowItWorks/js/jquery-3.6.0.min.js"></script>
<script>var base_url = "/LinuxCNC_HowItWorks/";</script>
<script src="/LinuxCNC_HowItWorks/js/theme_extra.js"></script>
<script src="/LinuxCNC_HowItWorks/js/theme.js"></script>
<script src="/LinuxCNC_HowItWorks/search/main.js"></script>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
29 changes: 0 additions & 29 deletions docs/Makefile
View file

This file was deleted.

186 changes: 186 additions & 0 deletions docs/about-mkdocs/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<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://Tpj-root.github.io/LinuxCNC_HowItWorks/about-mkdocs/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>About MkDocs - LinuxCNC_HowItWorks</title>
<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/11.8.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 = "/LinuxCNC_HowItWorks/about-mkdocs/";
</script>

<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</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"> LinuxCNC_HowItWorks
</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" aria-label="Search docs" title="Type search term here" />
</form>
</div>
</div>

<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<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="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">LinuxCNC_HowItWorks</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=".." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item active">About MkDocs</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Tpj-root/LinuxCNC_HowItWorks/edit/main/docs/docs/about-mkdocs.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">

<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=".." class="btn btn-neutral float-left" title="Home"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../tutorial/tldr/" class="btn btn-neutral float-right" title="TL;DR">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/readthedocs/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/Tpj-root/LinuxCNC_HowItWorks" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>


<span><a href=".." style="color: #fcfcfc">&laquo; Previous</a></span>


<span><a href="../tutorial/tldr/" style="color: #fcfcfc">Next &raquo;</a></span>

</span>
</div>
<script src="../js/jquery-3.6.0.min.js"></script>
<script>var base_url = "..";</script>
<script src="../js/theme_extra.js"></script>
<script src="../js/theme.js"></script>
<script src="../search/main.js"></script>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
Binary file added docs/css/fonts/Roboto-Slab-Bold.woff
View file
Binary file not shown.
Binary file added docs/css/fonts/Roboto-Slab-Bold.woff2
View file
Binary file not shown.
Binary file added docs/css/fonts/Roboto-Slab-Regular.woff
View file
Binary file not shown.
Binary file added docs/css/fonts/Roboto-Slab-Regular.woff2
View file
Binary file not shown.
Binary file added docs/css/fonts/fontawesome-webfont.eot
View file
Binary file not shown.
Loading

0 comments on commit 81f6006

Please sign in to comment.