deploy: f3c20b7

README.html

@@ -27,7 +27,7 @@
       Search
     </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-2955e59c></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-15113a2f><!----> <!----></div></div> <div id="flex-body"><div id="content-wrapper" class="fixed-header-padding"><h1 id="catcher-product-site"><span id="catcher-product-site" class="anchor"></span>CATcher Product Site<a href="#catcher-product-site" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <h1 id="setting-up"><span id="setting-up" class="anchor"></span>Setting up<a href="#setting-up" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <p>This section guides you through the steps required to set up a development container using <code class="hljs inline no-lang">Docker</code> and <code class="hljs inline no-lang">VSCode</code> for developing CATcher's user guide site.</p> <h2 id="prerequisites"><span id="prerequisites" class="anchor"></span>Prerequisites<a href="#prerequisites" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>Install the following programs:</p> <ul><li><a href="https://code.visualstudio.com/">VSCode</a></li> <li><a href="https://www.docker.com/">Docker Desktop</a></li></ul> <h2 id="getting-started"><span id="getting-started" class="anchor"></span>Getting Started<a href="#getting-started" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <ol><li>Open the folder in VSCode. The Dev Containers extension should be recommended.
 <ol><li><a href="/assets/dev-container-recommended-ext.png" target="_self"><img src="/assets/dev-container-recommended-ext.png" alt="" class="img-fluid"></a> Click on <strong>Install</strong></li> <li>Ensure that you follow the installation guide for the extension pack as well, especially for operating system-specific steps.</li></ol></li> <li><a href="/assets/reopen-in-container.png" target="_self"><img src="/assets/reopen-in-container.png" alt="" class="img-fluid"></a> Click <strong>Reopen in Container</strong> <ol><li><a href="/assets/open-a-remote-window.png" target="_self"><img src="/assets/open-a-remote-window.png" alt="" class="img-fluid"></a>  Or click the <em>double arrow icon</em> in the bottom left of the window.</li> <li>Select <strong>Reopen in Container</strong></li></ol></li> <li>After container build, press any key to access shell.</li> <li>You may start the application with <code class="hljs inline no-lang">markbind serve</code></li></ol> <blockquote><p>If you encounter <code class="hljs inline no-lang">Error: Cannot find module '/home/vscode/.vscode-server/data/User/workspaceStorage/a58265afe7bacfc76c46ea6bab19d711/ms-vscode.js-debug/bootloader.js'</code></p> <ol><li>Open <code class="hljs inline no-lang">&quot;debug.javascript.autoAttachFilter&quot;: &quot;disabled&quot;</code> in User Settings</li> <li>Toggle settings to anything valid, pausing a few moment between each change.</li> <li>Try again</li></ol> <p>Dev Containers seem to still be rather stateful. Fix taken from <a href="https://www.davidwesst.com/blog/missing-bootloader-in-vscode-devcontainer/">here</a>. Good news is the error does not show up unless you rebuild the container.</p></blockquote> <h3 id="git-settings"><span id="git-settings" class="anchor"></span>Git Settings<a href="#git-settings" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>Follow official documentation <a href="https://code.visualstudio.com/docs/remote/containers#_sharing-git-credentials-with-your-container">here</a></p> <h1 id="setting-up-alt"><span id="setting-up-alt" class="anchor"></span>Setting up [alt]<a href="#setting-up-alt" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <p>This section guides you through the steps required to set up a local development environment for developing CATcher's user guide site.</p> <h2 id="prerequisites-2"><span id="prerequisites-2" class="anchor"></span>Prerequisites<a href="#prerequisites-2" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>You need Node 14 to develop this project.
-Run <code class="hljs inline no-lang">node -v</code> in your OS terminal to check the version of Node on your computer.</p> <p>If you do not have Node 14 installed in your computer, click on <a href="https://nodejs.org/en/download/releases/">this link</a> to download Node 14.</p> <h2 id="getting-started-2"><span id="getting-started-2" class="anchor"></span>Getting Started<a href="#getting-started-2" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <ol><li><p>Fork this repository into your Github account.</p></li> <li><p>Clone the forked repository into your computer.</p></li> <li><p>Install MarkBind with npm: Run <code class="hljs inline no-lang">npm install -g markbind-cli</code>.</p></li> <li><p>Compile and start the application: Run <code class="hljs inline no-lang">markbind serve</code>.</p> <ul><li><strong>Note</strong>: If this step fails, it may be possible that the port that <code class="hljs inline no-lang">MarkBind</code> is attempting to serve the site in is being used. This may be rectified with the following command: <code class="hljs inline no-lang">markbind serve -p &lt;available_port&gt;</code>.</li></ul></li></ol> <i id="scroll-top-button" onclick="handleScrollTop()" aria-hidden="true" class="fa fa-arrow-circle-up fa-lg d-print-none"></i></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 4.1.0</a>, generated on Sun, 1 Oct 2023, 9:23:46 UTC]</small></div></footer></div>
+Run <code class="hljs inline no-lang">node -v</code> in your OS terminal to check the version of Node on your computer.</p> <p>If you do not have Node 14 installed in your computer, click on <a href="https://nodejs.org/en/download/releases/">this link</a> to download Node 14.</p> <h2 id="getting-started-2"><span id="getting-started-2" class="anchor"></span>Getting Started<a href="#getting-started-2" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <ol><li><p>Fork this repository into your Github account.</p></li> <li><p>Clone the forked repository into your computer.</p></li> <li><p>Install MarkBind with npm: Run <code class="hljs inline no-lang">npm install -g markbind-cli</code>.</p></li> <li><p>Compile and start the application: Run <code class="hljs inline no-lang">markbind serve</code>.</p> <ul><li><strong>Note</strong>: If this step fails, it may be possible that the port that <code class="hljs inline no-lang">MarkBind</code> is attempting to serve the site in is being used. This may be rectified with the following command: <code class="hljs inline no-lang">markbind serve -p &lt;available_port&gt;</code>.</li></ul></li></ol> <i id="scroll-top-button" onclick="handleScrollTop()" aria-hidden="true" class="fa fa-arrow-circle-up fa-lg d-print-none"></i></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 4.1.0</a>, generated on Tue, 12 Dec 2023, 7:52:15 UTC]</small></div></footer></div>
 </body><script src="/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()