Skip to content

Commit

Permalink
deploy: 2b09122
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Jun 14, 2024
1 parent 1958727 commit e6c0f3c
Show file tree
Hide file tree
Showing 45 changed files with 6,361 additions and 187 deletions.
22 changes: 9 additions & 13 deletions README.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,25 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="MarkBind 5.0.1">
<meta name="viewport" content="width=device-width, initial-scale=1"><title>WATcher</title><link rel="stylesheet" href="/WATcher-docs/markbind/css/bootstrap.min.css">
<link rel="stylesheet" href="/WATcher-docs/markbind/fontawesome/css/all.min.css">
<link rel="stylesheet" href="/WATcher-docs/markbind/glyphicons/css/bootstrap-glyphicons.min.css">
<link rel="stylesheet" href="/WATcher-docs/markbind/css/octicons.css">
<link rel="stylesheet" href="/WATcher-docs/markbind/material-icons/material-icons.css">
<link rel="stylesheet" href="/WATcher-docs/markbind/css/codeblock-light.min.css"><link rel="stylesheet" href="/WATcher-docs/markbind/css/markbind.min.css"><script src="/WATcher-docs/markbind/js/polyfill.min.js"></script>
<script src="/WATcher-docs/markbind/js/vue.min.js"></script>
<script src="/WATcher-docs/markbind/js/markbind.min.js"></script>
<script src="README.page-vue-render.js"></script><link rel="stylesheet" href="/WATcher-docs/plugins/markbind-plugin-anchors/markbind-plugin-anchors.css"><link rel="stylesheet" href="/WATcher-docs/plugins/markbind-plugin-tree/markbind-plugin-tree.css">
<meta name="generator" content="MarkBind 5.5.2">
<meta name="viewport" content="width=device-width, initial-scale=1"><title>WATcher</title> <link rel="stylesheet" href="/WATcher-docs/markbind/css/bootstrap.min.css"> <link rel="stylesheet" href="/WATcher-docs/markbind/fontawesome/css/all.min.css"><link rel="stylesheet" href="/WATcher-docs/markbind/css/codeblock-light.min.css"><link rel="stylesheet" href="/WATcher-docs/markbind/css/markbind.min.css"><link rel="stylesheet" href="/WATcher-docs/plugins/markbind-plugin-anchors/markbind-plugin-anchors.css"><link rel="stylesheet" href="/WATcher-docs/plugins/markbind-plugin-tree/markbind-plugin-tree.css">

<link rel="stylesheet" href="/WATcher-docs/css/main.css">
</head>
<script>
const baseUrl = '/WATcher-docs'
</script>
<body >
<div id="app" data-server-rendered="true"><div data-v-73b4aa16><nav class="navbar navbar-expand-md d-print-none navbar-dark bg-dark" data-v-73b4aa16><div class="container-fluid" data-v-73b4aa16><div class="navbar-left" data-v-73b4aa16><a href="/WATcher-docs/index.html" title="Home" class="navbar-brand" data-v-73b4aa16><img src="/WATcher-docs/images/catcher_logo.png" width="40" data-v-73b4aa16></a></div> <div class="navbar-default" data-v-73b4aa16><ul class="navbar-nav me-auto mt-2 mt-lg-0" data-v-73b4aa16> <li data-v-73b4aa16><a href="/WATcher-docs/index.html" class="nav-link" data-v-73b4aa16>HOME</a></li> <li data-v-73b4aa16><a href="/WATcher-docs/ug/index.html" class="nav-link" data-v-73b4aa16> USER GUIDE </a></li> <li data-v-73b4aa16><a href="/WATcher-docs/dg/index.html" class="nav-link" data-v-73b4aa16> DEVELOPER GUIDE </a></li> <li data-v-73b4aa16><a href="/WATcher-docs/about-us.html" class="nav-link" data-v-73b4aa16> ABOUT US </a></li> <li data-v-73b4aa16><a href="https://github.com/CATcher-org/WATcher" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fab fa-github" data-v-73b4aa16></span></span></a></li></ul></div> <ul class="navbar-nav navbar-right" data-v-73b4aa16><li data-v-73b4aa16><form class="navbar-form" data-v-73b4aa16><div class="dropdown" style="position:relative;" data-v-01e11c9b><input data-bs-toggle="dropdown" type="text" placeholder="Search" autocomplete="off" value="" class="form-control" data-v-01e11c9b> <div class="form-control placeholder-div-hidden" data-v-01e11c9b>
<div id="app" data-server-rendered="true"><div data-v-7c0fd418><nav class="navbar navbar-expand-md d-print-none navbar-dark bg-dark" data-v-7c0fd418><div class="container-fluid" data-v-7c0fd418><div class="navbar-left" data-v-7c0fd418><a href="/WATcher-docs/index.html" title="Home" class="navbar-brand" data-v-7c0fd418><img src="/WATcher-docs/images/catcher_logo.png" width="40" data-v-7c0fd418></a></div> <div class="navbar-default" data-v-7c0fd418><ul class="navbar-nav me-auto mt-2 mt-lg-0" data-v-7c0fd418> <li data-v-7c0fd418><a href="/WATcher-docs/index.html" class="nav-link" data-v-7c0fd418>HOME</a></li> <li data-v-7c0fd418><a href="/WATcher-docs/ug/index.html" class="nav-link" data-v-7c0fd418> USER GUIDE </a></li> <li data-v-7c0fd418><a href="/WATcher-docs/dg/index.html" class="nav-link" data-v-7c0fd418> DEVELOPER GUIDE </a></li> <li data-v-7c0fd418><a href="/WATcher-docs/about-us.html" class="nav-link" data-v-7c0fd418> ABOUT US </a></li> <li data-v-7c0fd418><a href="https://github.com/CATcher-org/WATcher" target="_blank" class="nav-link" data-v-7c0fd418><span data-v-7c0fd418><span aria-hidden="true" class="fab fa-github" data-v-7c0fd418></span></span></a></li></ul></div> <ul class="navbar-nav navbar-right" data-v-7c0fd418><li data-v-7c0fd418><form class="navbar-form" data-v-7c0fd418><div class="dropdown" style="position:relative;" data-v-cea1a814><input data-bs-toggle="dropdown" type="text" placeholder="Search" autocomplete="off" value="" class="form-control" data-v-cea1a814> <div class="form-control placeholder-div-hidden" data-v-cea1a814>
Search
</div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div id="flex-body"><div id="content-wrapper" class="fixed-header-padding"><h1 id="watcher-product-site">WATcher Product Site<a href="#watcher-product-site" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <h1 id="setting-up">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 WATcher's user guide site.</p> <h2 id="prerequisites">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">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.
</div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-cea1a814></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-7c0fd418><!----> <!----></div></div> <div id="flex-body"><div id="content-wrapper" class="fixed-header-padding"><h1 id="watcher-product-site">WATcher Product Site<a href="#watcher-product-site" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <h1 id="setting-up">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 WATcher's user guide site.</p> <h2 id="prerequisites">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">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="/WATcher-docs/assets/dev-container-recommended-ext.png" target="_self"><img src="/WATcher-docs/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="/WATcher-docs/assets/reopen-in-container.png" target="_self"><img src="/WATcher-docs/assets/reopen-in-container.png" alt="" class="img-fluid"></a> Click <strong>Reopen in Container</strong> <ol><li><a href="/WATcher-docs/assets/open-a-remote-window.png" target="_self"><img src="/WATcher-docs/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">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">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 WATcher's user guide site.</p> <h2 id="prerequisites-2">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">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></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 5.0.1</a>, generated on Tue, 18 Jul 2023, 3:46:54 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">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></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 5.5.2</a>, generated on Fri, 14 Jun 2024, 5:33:24 UTC]</small></div></footer></div>
</body><script src="/WATcher-docs/markbind/js/bootstrap-utility.min.js"></script>
<script src="/WATcher-docs/markbind/js/polyfill.min.js"></script>
<script src="/WATcher-docs/markbind/js/vue.min.js"></script>
<script src="/WATcher-docs/markbind/js/markbind.min.js"></script>
<script src="README.page-vue-render.js"></script>
<script>
MarkBind.setupWithSearch()
</script>
Expand Down
Loading

0 comments on commit e6c0f3c

Please sign in to comment.