-
-
Notifications
You must be signed in to change notification settings - Fork 72
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deployed 3140ca9 with MkDocs version: 1.4.3
- Loading branch information
Showing
24 changed files
with
5,127 additions
and
774 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,20 +8,20 @@ | |
|
||
|
||
|
||
<link rel="canonical" href="https://streetpea.github.io/chiaki4deck/diy/builddocs/"> | ||
<link rel="canonical" href="https://streetpea.github.io/chiaki-ng/diy/builddocs/"> | ||
|
||
|
||
<link rel="prev" href="../buildit/"> | ||
|
||
|
||
<link rel="next" href="../steamdeckdev/"> | ||
|
||
<link rel="icon" href="../../images/chiaki4deck.svg"> | ||
<link rel="icon" href="../../images/chiaking.svg"> | ||
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.18"> | ||
|
||
|
||
|
||
<title>Locally Building Documentation - chiaki4deck</title> | ||
<title>Locally Building Documentation - chiaki-ng</title> | ||
|
||
|
||
|
||
|
@@ -117,9 +117,9 @@ | |
|
||
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header"> | ||
<nav class="md-header__inner md-grid" aria-label="Header"> | ||
<a href="../.." title="chiaki4deck" class="md-header__button md-logo" aria-label="chiaki4deck" data-md-component="logo"> | ||
<a href="../.." title="chiaki-ng" class="md-header__button md-logo" aria-label="chiaki-ng" data-md-component="logo"> | ||
|
||
<img src="../../images/chiaki4deck.svg" alt="logo"> | ||
<img src="../../images/chiaking-logo-white.svg" alt="logo"> | ||
|
||
</a> | ||
<label class="md-header__button md-icon" for="__drawer"> | ||
|
@@ -129,7 +129,7 @@ | |
<div class="md-header__ellipsis"> | ||
<div class="md-header__topic"> | ||
<span class="md-ellipsis"> | ||
chiaki4deck | ||
chiaki-ng | ||
</span> | ||
</div> | ||
<div class="md-header__topic" data-md-component="header-topic"> | ||
|
@@ -209,7 +209,7 @@ | |
|
||
|
||
<div class="md-header__source"> | ||
<a href="https://github.com/streetpea/chiaki4deck" title="Go to repository" class="md-source" data-md-component="source"> | ||
<a href="https://github.com/streetpea/chiaki-ng" title="Go to repository" class="md-source" data-md-component="source"> | ||
<div class="md-source__icon md-icon"> | ||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg> | ||
|
@@ -329,16 +329,16 @@ | |
|
||
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0"> | ||
<label class="md-nav__title" for="__drawer"> | ||
<a href="../.." title="chiaki4deck" class="md-nav__button md-logo" aria-label="chiaki4deck" data-md-component="logo"> | ||
<a href="../.." title="chiaki-ng" class="md-nav__button md-logo" aria-label="chiaki-ng" data-md-component="logo"> | ||
|
||
<img src="../../images/chiaki4deck.svg" alt="logo"> | ||
<img src="../../images/chiaking-logo-white.svg" alt="logo"> | ||
|
||
</a> | ||
chiaki4deck | ||
chiaki-ng | ||
</label> | ||
|
||
<div class="md-nav__source"> | ||
<a href="https://github.com/streetpea/chiaki4deck" title="Go to repository" class="md-source" data-md-component="source"> | ||
<a href="https://github.com/streetpea/chiaki-ng" title="Go to repository" class="md-source" data-md-component="source"> | ||
<div class="md-source__icon md-icon"> | ||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg> | ||
|
@@ -727,7 +727,7 @@ | |
|
||
<li class="md-nav__item"> | ||
<a href="../steamdeckdev/" class="md-nav__link"> | ||
Developing chiaki4deck on Steam Deck | ||
Developing chiaki-ng on Steam Deck | ||
</a> | ||
</li> | ||
|
||
|
@@ -803,7 +803,7 @@ | |
|
||
|
||
|
||
<a href="https://github.com/streetpea/chiaki4deck/edit/chiaki4deck/docs/diy/builddocs.md" title="Edit this page" class="md-content__button md-icon"> | ||
<a href="https://github.com/streetpea/chiaki-ng/edit/chiaki-ng/docs/diy/builddocs.md" title="Edit this page" class="md-content__button md-icon"> | ||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4v-2m10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1 2.1 2.1Z"/></svg> | ||
</a> | ||
|
@@ -812,7 +812,7 @@ | |
|
||
|
||
|
||
<a href="https://github.com/streetpea/chiaki4deck/raw/chiaki4deck/docs/diy/builddocs.md" title="View source of this page" class="md-content__button md-icon"> | ||
<a href="https://github.com/streetpea/chiaki-ng/raw/chiaki-ng/docs/diy/builddocs.md" title="View source of this page" class="md-content__button md-icon"> | ||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.15 8.15 0 0 1-1.23-2Z"/></svg> | ||
</a> | ||
|
@@ -822,13 +822,13 @@ | |
<h1 id="building-the-documentation-yourself">Building the Documentation Yourself<a class="headerlink" href="#building-the-documentation-yourself" title="Permanent link">¶</a></h1> | ||
<div class="admonition warning"> | ||
<p class="admonition-title">For Documentation Contributors Only</p> | ||
<p>This is for people who want to update the documentation of <code>chiaki4deck</code> and see the updates locally or if you are a regular user and are curious on how to do it. In most cases, just accessing the documentation via the site <a href="https://streetpea.github.io/chiaki4deck/">https://streetpea.github.io/chiaki4deck/</a> is best. If you want to access the documentation without internet access, instead of following this documentation, you should navigate to the print page (which displays the documentation in printable format). Then, Print->Save to pdf in your web browser and access the PDF freely offline.</p> | ||
<p>This is for people who want to update the documentation of <code>chiaki-ng</code> and see the updates locally or if you are a regular user and are curious on how to do it. In most cases, just accessing the documentation via the site <a href="https://streetpea.github.io/chiaki-ng/">https://streetpea.github.io/chiaki-ng/</a> is best. If you want to access the documentation without internet access, instead of following this documentation, you should navigate to the print page (which displays the documentation in printable format). Then, Print->Save to pdf in your web browser and access the PDF freely offline.</p> | ||
</div> | ||
<h2 id="installing-necessary-pre-requisites">Installing Necessary Pre-requisites<a class="headerlink" href="#installing-necessary-pre-requisites" title="Permanent link">¶</a></h2> | ||
<ol> | ||
<li>Install pip3 on your computer, if it's not already installed (instructions vary depending on Operating System)</li> | ||
<li> | ||
<p>Install mkdocs and plugins used in chiaki4deck documentation</p> | ||
<p>Install mkdocs and plugins used in chiaki-ng documentation</p> | ||
<div class="highlight"><pre><span></span><code>pip3<span class="w"> </span>install<span class="w"> </span>mkdocs<span class="w"> </span>mkdocs-material<span class="w"> </span>mkdocs-git-revision-date-localized-plugin<span class="w"> </span>mkdocs-print-site-plugin | ||
</code></pre></div> | ||
</li> | ||
|
@@ -837,15 +837,15 @@ <h2 id="installing-necessary-pre-requisites">Installing Necessary Pre-requisites | |
<div class="tabbed-set tabbed-alternate" data-tabs="1:3"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><input id="__tabbed_1_3" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">HTTPS</label><label for="__tabbed_1_2">SSH</label><label for="__tabbed_1_3">GitHub cli</label></div> | ||
<div class="tabbed-content"> | ||
<div class="tabbed-block"> | ||
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/streetpea/chiaki4deck.git | ||
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/streetpea/chiaki-ng.git | ||
</code></pre></div> | ||
</div> | ||
<div class="tabbed-block"> | ||
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>[email protected]:streetpea/chiaki4deck.git<span class="w"> </span> | ||
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>[email protected]:streetpea/chiaki-ng.git | ||
</code></pre></div> | ||
</div> | ||
<div class="tabbed-block"> | ||
<div class="highlight"><pre><span></span><code>gh<span class="w"> </span>repo<span class="w"> </span>clone<span class="w"> </span>streetpea/chiaki4deck | ||
<div class="highlight"><pre><span></span><code>gh<span class="w"> </span>repo<span class="w"> </span>clone<span class="w"> </span>streetpea/chiaki-ng | ||
</code></pre></div> | ||
</div> | ||
</div> | ||
|
@@ -896,7 +896,7 @@ <h2 id="installing-necessary-pre-requisites">Installing Necessary Pre-requisites | |
<small> | ||
|
||
Last update: | ||
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">January 5, 2023</span> | ||
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 28, 2024</span> | ||
|
||
<br> | ||
Created: | ||
|
@@ -943,7 +943,7 @@ <h2 id="installing-necessary-pre-requisites">Installing Necessary Pre-requisites | |
|
||
|
||
|
||
Thanks for your feedback! Help me improve this page by using my <a href="https://github.com/streetpea/chiaki4deck/issues/new/?title=[Feedback]+Locally%20Building%20Documentation+-+/diy/builddocs/" target="_blank" rel="noopener">feedback form</a>. | ||
Thanks for your feedback! Help me improve this page by using my <a href="https://github.com/streetpea/chiaki-ng/issues/new/?title=[Feedback]+Locally%20Building%20Documentation+-+/diy/builddocs/" target="_blank" rel="noopener">feedback form</a>. | ||
</div> | ||
|
||
</div> | ||
|
@@ -991,13 +991,13 @@ <h2 id="installing-necessary-pre-requisites">Installing Necessary Pre-requisites | |
|
||
|
||
|
||
<a href="../steamdeckdev/" class="md-footer__link md-footer__link--next" aria-label="Next: Developing chiaki4deck on Steam Deck" rel="next"> | ||
<a href="../steamdeckdev/" class="md-footer__link md-footer__link--next" aria-label="Next: Developing chiaki-ng on Steam Deck" rel="next"> | ||
<div class="md-footer__title"> | ||
<span class="md-footer__direction"> | ||
Next | ||
</span> | ||
<div class="md-ellipsis"> | ||
Developing chiaki4deck on Steam Deck | ||
Developing chiaki-ng on Steam Deck | ||
</div> | ||
</div> | ||
<div class="md-footer__button md-icon"> | ||
|
@@ -1034,7 +1034,7 @@ <h2 id="installing-necessary-pre-requisites">Installing Necessary Pre-requisites | |
|
||
|
||
|
||
<a href="https://github.com/streetpea/chiaki4deck" target="_blank" rel="noopener" title="github.com" class="md-social__link"> | ||
<a href="https://github.com/streetpea/chiaki-ng" target="_blank" rel="noopener" title="github.com" class="md-social__link"> | ||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg> | ||
</a> | ||
|
||
|
Oops, something went wrong.