more configs and readme updates.
This commit is contained in:
@@ -674,6 +674,15 @@ Changemaker Archive. <a href="https://docs.bnkops.com">Learn more</a>
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#reset-site" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Reset Site
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#how-to-build-your-site-step-by-step" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@@ -1463,6 +1472,15 @@ Changemaker Archive. <a href="https://docs.bnkops.com">Learn more</a>
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#reset-site" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Reset Site
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#how-to-build-your-site-step-by-step" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@@ -1527,17 +1545,21 @@ Changemaker Archive. <a href="https://docs.bnkops.com">Learn more</a>
|
||||
<h1 id="building-the-site-with-mkdocs-material">Building the Site with MkDocs Material<a class="headerlink" href="#building-the-site-with-mkdocs-material" title="Permanent link">¶</a></h1>
|
||||
<p>Welcome! This guide will help you get started building and customizing your site using <a href="https://squidfunk.github.io/mkdocs-material/">MkDocs Material</a>.</p>
|
||||
<hr />
|
||||
<h2 id="reset-site">Reset Site<a class="headerlink" href="#reset-site" title="Permanent link">¶</a></h2>
|
||||
<p>You can read through all the BNKops cmlite documentation already in your docs folder or you can reset your docs folder to a baseline to start and read more manuals at <a href="cmlite.org">cmlite.org</a>. To reset docs folder to baseline, run the following: </p>
|
||||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>./reset-site.sh
|
||||
</span></code></pre></div>
|
||||
<h2 id="how-to-build-your-site-step-by-step">🚀 How to Build Your Site (Step by Step)<a class="headerlink" href="#how-to-build-your-site-step-by-step" title="Permanent link">¶</a></h2>
|
||||
<ol>
|
||||
<li><strong>Open your Coder instance.</strong>
|
||||
For example: coder.yourdomain.com</li>
|
||||
<li><strong>Go to the mkdocs folder:</strong><br />
|
||||
In the terminal (for a new terminal press Crtl - Shift - ~), type:
|
||||
<div class="language-sh highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nb">cd</span><span class="w"> </span>mkdocs
|
||||
<div class="language-sh highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nb">cd</span><span class="w"> </span>mkdocs
|
||||
</span></code></pre></div></li>
|
||||
<li><strong>Build the site:</strong><br />
|
||||
Type:
|
||||
<div class="language-sh highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>mkdocs<span class="w"> </span>build
|
||||
<div class="language-sh highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>mkdocs<span class="w"> </span>build
|
||||
</span></code></pre></div>
|
||||
This creates the static website from your documents and places them in the <code>mkdocs/site</code> directory.</li>
|
||||
</ol>
|
||||
@@ -1590,7 +1612,7 @@ Changemaker Archive. <a href="https://docs.bnkops.com">Learn more</a>
|
||||
<ul>
|
||||
<li>If you have a <a href="https://claude.ai/">claude.ai</a> subscription, you can use powerful AI in your Coder terminal to write or rewrite pages, including a new <code>home.html</code>.</li>
|
||||
<li>All you need to do is open the terminal and type:
|
||||
<div class="language-sh highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>claude
|
||||
<div class="language-sh highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>claude
|
||||
</span></code></pre></div></li>
|
||||
<li>You can also try local AI tools like <a href="https://ollama.com/">Ollama</a> for on-demand help.</li>
|
||||
</ul>
|
||||
|
||||
Reference in New Issue
Block a user