Skip to content

Commit

Permalink
Merge pull request #31 from breiler/gh-pages
Browse files Browse the repository at this point in the history 
Deployed 62c09fc with MkDocs version: 1.5.3
  • Loading branch information
@breiler
breiler authored Dec 2, 2023
2 parents bbbf548 + 84defa9 commit 41e15ab
Show file tree
Hide file tree
Showing 24 changed files with 1,175 additions and 2,137 deletions.
72 changes: 12 additions & 60 deletions 404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,17 @@
<link href="/css/bootstrap.min.css" rel="stylesheet">
<link href="/css/font-awesome.min.css" rel="stylesheet">
<link href="/css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/purebasic.min.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/purebasic.min.css">
<link href="/css/style.css" rel="stylesheet">

<script src="/js/jquery-1.10.2.min.js" defer></script>
<script src="/js/bootstrap.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>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-73554112-1', 'auto');
ga('create', "UA-73554112-1", "auto");
ga('send', 'pageview');
</script>
</head>
Expand All @@ -49,55 +46,11 @@
<li class="navitem">
<a href="/download/" class="nav-link">Download</a>
</li>
<li class="dropdown">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">User Guide <b class="caret"></b></a>
<ul class="dropdown-menu">

<li>
<a href="/guide/languages/" class="dropdown-item">Languages</a>
</li>

<li>
<a href="/guide/common/" class="dropdown-item">Common Features</a>
</li>

<li>
<a href="/guide/classic/" class="dropdown-item">Classic</a>
</li>

<li>
<a href="/guide/platform/" class="dropdown-item">Platform</a>
</li>

<li>
<a href="/guide/troubleshooting/" class="dropdown-item">Help</a>
</li>
</ul>
<li class="navitem">
<a href="/installing/" class="nav-link">Installing</a>
</li>
<li class="dropdown">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Developer Guide <b class="caret"></b></a>
<ul class="dropdown-menu">

<li>
<a href="/dev/getting_started/" class="dropdown-item">Getting Started</a>
</li>

<li>
<a href="/dev/backend_development/" class="dropdown-item">Backend</a>
</li>

<li>
<a href="/dev/frontend_development/" class="dropdown-item">Frontend</a>
</li>

<li>
<a href="/dev/plugin/" class="dropdown-item">Plugin</a>
</li>

<li>
<a href="/dev/gcode_processor/" class="dropdown-item">Gcode Processors</a>
</li>
</ul>
<li class="navitem">
<a href="/usage/" class="nav-link">Usage</a>
</li>
<li class="navitem">
<a href="/contributing/" class="nav-link">Contributing</a>
Expand All @@ -110,9 +63,6 @@
<i class="fa fa-search"></i> Search
</a>
</li>
<li class="nav-item">
<a href="https://github.com/winder/ugs_website" class="nav-link"><i class="fa fa-github"></i> GitHub</a>
</li>
</ul>
</div>
</div>
Expand All @@ -136,12 +86,14 @@ <h1 id="404-page-not-found" style="text-align: center">404</h1>
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script src="/js/jquery-3.6.0.min.js"></script>
<script src="/js/bootstrap.min.js"></script>
<script>
var base_url = "/",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="/js/base.js" defer></script>
<script src="/search/main.js" defer></script>
<script src="/js/base.js"></script>
<script src="/search/main.js"></script>

<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
<div class="modal-dialog modal-lg">
Expand Down
101 changes: 15 additions & 86 deletions contributing/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,17 @@
<link href="../css/bootstrap.min.css" rel="stylesheet">
<link href="../css/font-awesome.min.css" rel="stylesheet">
<link href="../css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/purebasic.min.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/purebasic.min.css">
<link href="../css/style.css" rel="stylesheet">

<script src="../js/jquery-1.10.2.min.js" defer></script>
<script src="../js/bootstrap.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>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-73554112-1', 'auto');
ga('create', "UA-73554112-1", "auto");
ga('send', 'pageview');
</script>
</head>
Expand All @@ -49,55 +46,11 @@
<li class="navitem">
<a href="../download/" class="nav-link">Download</a>
</li>
<li class="dropdown">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">User Guide <b class="caret"></b></a>
<ul class="dropdown-menu">

<li>
<a href="../guide/languages/" class="dropdown-item">Languages</a>
</li>

<li>
<a href="../guide/common/" class="dropdown-item">Common Features</a>
</li>

<li>
<a href="../guide/classic/" class="dropdown-item">Classic</a>
</li>

<li>
<a href="../guide/platform/" class="dropdown-item">Platform</a>
</li>

<li>
<a href="../guide/troubleshooting/" class="dropdown-item">Help</a>
</li>
</ul>
<li class="navitem">
<a href="../installing/" class="nav-link">Installing</a>
</li>
<li class="dropdown">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Developer Guide <b class="caret"></b></a>
<ul class="dropdown-menu">

<li>
<a href="../dev/getting_started/" class="dropdown-item">Getting Started</a>
</li>

<li>
<a href="../dev/backend_development/" class="dropdown-item">Backend</a>
</li>

<li>
<a href="../dev/frontend_development/" class="dropdown-item">Frontend</a>
</li>

<li>
<a href="../dev/plugin/" class="dropdown-item">Plugin</a>
</li>

<li>
<a href="../dev/gcode_processor/" class="dropdown-item">Gcode Processors</a>
</li>
</ul>
<li class="navitem">
<a href="../usage/" class="nav-link">Usage</a>
</li>
<li class="navitem active">
<a href="./" class="nav-link">Contributing</a>
Expand All @@ -111,7 +64,7 @@
</a>
</li>
<li class="nav-item">
<a rel="prev" href="../dev/gcode_processor/" class="nav-link">
<a rel="prev" href="../usage/" class="nav-link">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
Expand All @@ -120,9 +73,6 @@
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
<li class="nav-item">
<a href="https://github.com/winder/ugs_website/edit/master/docs/contributing.md" class="nav-link"><i class="fa fa-github"></i> Edit on GitHub</a>
</li>
</ul>
</div>
</div>
Expand Down Expand Up @@ -176,32 +126,9 @@ <h2 id="code">Code</h2>
<p>If you're planning to make a lot of changes please create an issue to discuss
implementation details. A lot of effort has gone into the current design so we
want to make sure everything will to work together.</p>
<p>Checkout the <a href="https://github.com/winder/Universal-G-Code-Sender/wiki/Developing">Developing wiki page for more details</a></p>
<h2 id="documentation">Documentation</h2>
<p>If you find any errors in the documentation or if there are missing pages, you are welcome to contribute!
It is written using <a href="http://www.mkdocs.org/user-guide/writing-your-docs/">MkDocs</a> and <a href="https://guides.github.com/features/mastering-markdown/">Markdown</a>. Follow these instructions to get started:</p>
<ul>
<li><a href="https://help.github.com/articles/committing-changes-to-a-pull-request-branch-created-from-a-fork/">Fork and clone</a> the repository <a href="https://github.com/winder/ugs_website">https://github.com/winder/ugs_website</a>.</li>
<li>
<p>Make sure you have <a href="https://www.python.org/downloads/">Python</a> installed with this command in your terminal:</p>
<pre><code>python --version
</code></pre>
</li>
<li>
<p>Install MkDocs and the theme modules </p>
<pre><code>sudo pip install mkdocs
sudo pip install mkdocs-bootswatch
</code></pre>
</li>
<li>
<p>From your cloned ugs_website directory run </p>
<pre><code>mkdocs serve
</code></pre>
</li>
<li>
<p>Go to <a href="http://localhost:8000/">http://localhost:8000/</a> in your browser</p>
</li>
</ul>
<p>Now, make your changes and see them live updating in your web browser. Create a <a href="https://help.github.com/articles/using-pull-requests/">pull request</a> in github and we will review and add your changes.</p>
<p>If you find any errors in the <a href="https://github.com/winder/Universal-G-Code-Sender/wiki/">documentation</a> or if there are missing pages, you are welcome to contribute! </p>
<h2 id="translations">Translations</h2>
<p>We are currently using <a href="https://poeditor.com/join/project/2J2hB5I41Z">POEditor</a> to manage localization.
If you would like to help please consider signing up to contribute through this service.</p>
Expand All @@ -225,12 +152,14 @@ <h3 id="adding-a-new-language">Adding a new language</h3>
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script src="../js/jquery-3.6.0.min.js"></script>
<script src="../js/bootstrap.min.js"></script>
<script>
var base_url = "..",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="../js/base.js" defer></script>
<script src="../search/main.js" defer></script>
<script src="../js/base.js"></script>
<script src="../search/main.js"></script>

<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
<div class="modal-dialog modal-lg">
Expand Down
84 changes: 13 additions & 71 deletions dev/backend_development/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,21 @@
<meta name="author" content="Will Winder">

<link rel="shortcut icon" href="../../img/favicon.ico">
<title>Backend - UGS</title>
<title>Backend architecture - UGS</title>
<link href="../../css/bootstrap.min.css" rel="stylesheet">
<link href="../../css/font-awesome.min.css" rel="stylesheet">
<link href="../../css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/purebasic.min.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/purebasic.min.css">
<link href="../../css/style.css" rel="stylesheet">

<script src="../../js/jquery-1.10.2.min.js" defer></script>
<script src="../../js/bootstrap.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>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-73554112-1', 'auto');
ga('create', "UA-73554112-1", "auto");
ga('send', 'pageview');
</script>
</head>
Expand All @@ -49,55 +46,11 @@
<li class="navitem">
<a href="../../download/" class="nav-link">Download</a>
</li>
<li class="dropdown">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">User Guide <b class="caret"></b></a>
<ul class="dropdown-menu">

<li>
<a href="../../guide/languages/" class="dropdown-item">Languages</a>
</li>

<li>
<a href="../../guide/common/" class="dropdown-item">Common Features</a>
</li>

<li>
<a href="../../guide/classic/" class="dropdown-item">Classic</a>
</li>

<li>
<a href="../../guide/platform/" class="dropdown-item">Platform</a>
</li>

<li>
<a href="../../guide/troubleshooting/" class="dropdown-item">Help</a>
</li>
</ul>
<li class="navitem">
<a href="../../installing/" class="nav-link">Installing</a>
</li>
<li class="dropdown active">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Developer Guide <b class="caret"></b></a>
<ul class="dropdown-menu">

<li>
<a href="../getting_started/" class="dropdown-item">Getting Started</a>
</li>

<li>
<a href="./" class="dropdown-item active">Backend</a>
</li>

<li>
<a href="../frontend_development/" class="dropdown-item">Frontend</a>
</li>

<li>
<a href="../plugin/" class="dropdown-item">Plugin</a>
</li>

<li>
<a href="../gcode_processor/" class="dropdown-item">Gcode Processors</a>
</li>
</ul>
<li class="navitem">
<a href="../../usage/" class="nav-link">Usage</a>
</li>
<li class="navitem">
<a href="../../contributing/" class="nav-link">Contributing</a>
Expand All @@ -110,19 +63,6 @@
<i class="fa fa-search"></i> Search
</a>
</li>
<li class="nav-item">
<a rel="prev" href="../getting_started/" class="nav-link">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li class="nav-item">
<a rel="next" href="../frontend_development/" class="nav-link">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
<li class="nav-item">
<a href="https://github.com/winder/ugs_website/edit/master/docs/dev/backend_development.md" class="nav-link"><i class="fa fa-github"></i> Edit on GitHub</a>
</li>
</ul>
</div>
</div>
Expand Down Expand Up @@ -316,12 +256,14 @@ <h1 id="streaming-strategy">Streaming strategy</h1>
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script src="../../js/jquery-3.6.0.min.js"></script>
<script src="../../js/bootstrap.min.js"></script>
<script>
var base_url = "../..",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="../../js/base.js" defer></script>
<script src="../../search/main.js" defer></script>
<script src="../../js/base.js"></script>
<script src="../../search/main.js"></script>

<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
<div class="modal-dialog modal-lg">
Expand Down
Loading

0 comments on commit 41e15ab

Please sign in to comment.