skq
/
skq-it-am
mirror of https://ci.sikuliaq.alaska.edu/git/skqit/skq-it-am.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Working CentOS 7 and OS X Client SW List

v0.0.11
John Haverlack 3 years ago
parent
1f386613ca
commit
92b3ae5ad9
29 changed files with 145 additions and 192 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 17
      index.js
  2. 3
      package.json
  3. 104
      skqitam-client/index.js
  4. 3
      skqitam-client/package.json
  5. 2
      start-server.sh
  6. 2
      web/root/mkdocs.yml
  7. 2
      web/root/site/404.html
  8. 18
      web/root/site/bootstrap.html
  9. 8
      web/root/site/build.html
  10. 11
      web/root/site/cloning.html
  11. 54
      web/root/site/code.html
  12. 2
      web/root/site/contact.html
  13. 5
      web/root/site/editing.html
  14. 11
      web/root/site/equations.html
  15. 5
      web/root/site/footnotes.html
  16. 5
      web/root/site/icons.html
  17. 2
      web/root/site/index.html
  18. 16
      web/root/site/install.html
  19. 2
      web/root/site/license.html
  20. 12
      web/root/site/menu.html
  21. 14
      web/root/site/optional.html
  22. 5
      web/root/site/pdf.html
  23. 4
      web/root/site/search.html
  24. 8
      web/root/site/sitemap.xml
  25. BIN
      web/root/site/sitemap.xml.gz
  26. 4
      web/root/site/swipe.html
  27. 11
      web/root/site/test.html
  28. 5
      web/root/site/version.html
  29. 2
      web/root/site/versions.html

17
index.js
View File

@ -94,7 +94,7 @@ app.use('/api/upload', function(req, res) {
let log_file = path.join(process['CONFIG']['LOCAL']['ITAM']['ITAM_DATA_DIR'], 'logs', now['UTC']['YYYY-MM-DD'] + '_itam-server.log')
try {
fs.appendFileSync(log_file, JSON.stringify(log) + "\n", 'utf8')
console.log (JSON.stringify(log) + "\n")
console.log (JSON.stringify(log))
} catch (err) {
console.log ("ERROR: Cannot LOG event to " + log_file)
}
@ -214,16 +214,17 @@ app.use(function (req, res, next) {
// Starting Express Web Service
app.listen(process['CONFIG']['GLOBAL']['WEBUI_PORT'], function () {
console.log("Sikuliaq Cyber Asset Manager Server")
console.log(" - Copyright (C) 2021 University of Alaska Fairbanks - College of Fisheries and Ocean Sciences - R/V Sikuliaq")
console.log(" - Author: John Haverlack (jehaverlack@alaska.edu)\n")
console.log("Status: STARTED")
console.log ("Sikuliaq Cyber Asset Manager Server")
console.log (" - Version: " + process['CONFIG']['LOCAL']['PACKAGE']['version'] + ' ' + process['CONFIG']['LOCAL']['PACKAGE']['version_date'])
console.log (" - Copyright (C) 2021 University of Alaska Fairbanks - College of Fisheries and Ocean Sciences - R/V Sikuliaq")
console.log (" - Author: John Haverlack (jehaverlack@alaska.edu)\n")
console.log ("Status: STARTED")
for (i in process['CONFIG']['LOCAL']['HOST']['NETWORK']['IP_ADDR']['IPv4']) {
console.log(" WebUI: http://" + process['CONFIG']['LOCAL']['HOST']['NETWORK']['IP_ADDR']['IPv4'][i] + ':' + process['CONFIG']['GLOBAL']['WEBUI_PORT'])
console.log (" WebUI: http://" + process['CONFIG']['LOCAL']['HOST']['NETWORK']['IP_ADDR']['IPv4'][i] + ':' + process['CONFIG']['GLOBAL']['WEBUI_PORT'])
}
for (i in process['CONFIG']['LOCAL']['HOST']['NETWORK']['IP_ADDR']['IPv6']) {
console.log(" WebUI: http://[" + process['CONFIG']['LOCAL']['HOST']['NETWORK']['IP_ADDR']['IPv6'][i] + ']:' + process['CONFIG']['GLOBAL']['WEBUI_PORT'])
console.log (" WebUI: http://[" + process['CONFIG']['LOCAL']['HOST']['NETWORK']['IP_ADDR']['IPv6'][i] + ']:' + process['CONFIG']['GLOBAL']['WEBUI_PORT'])
}
console.log("\nNOTE: Be sure to open port " + process['CONFIG']['GLOBAL']['WEBUI_PORT'] + " to the above IP's\n on server and network firewalls.")
console.log ("\nNOTE: Be sure to open port " + process['CONFIG']['GLOBAL']['WEBUI_PORT'] + " to the above IP's\n on server and network firewalls.")
})

3
package.json
View File

@ -1,8 +1,9 @@
{
"name": "skq-it-am",
"version": "0.0.4",
"version_date": "2021-06-15",
"version_date": "2021-06-16",
"description": "Sikuliaq IT Asset Manager",
"copyright": "University of Alaska Fairbanks - College of Fisheries and Ocean Science - R/V Sikuliaq",
"main": "index.js",
"dependencies": {
"archiver": "^5.3.0",

104
skqitam-client/index.js
View File

@ -45,6 +45,7 @@ process['CONFIG']['LOCAL'] = it_am_init()
console.log ("")
console.log ("Sikuliaq IT Asset Manager Client")
console.log (" Version: " + process['CONFIG']['LOCAL']['PACKAGE']['version'] + ' ' + process['CONFIG']['LOCAL']['PACKAGE']['version_date'])
console.log (" Copyright (C) 2021 University of Alaska Fairbanks - College of Fisheries and Ocean Sciences - R/V Sikuliaq")
console.log (" Author: John Haverlack (jehaverlack@alaska.edu)")
console.log ("")
@ -148,7 +149,6 @@ sw_source_map['Microsoft Windows 10 Home'] = 'GET_ITEMPROPERTY'
sw_source_map['macOS'] = 'SYSTEM_PROFILER'
am_data['SOURCE']['SW'] = {}
am_data['SOURCE']['SW'][ sw_source_map[ process['CONFIG']['LOCAL']['OS']['DISTRO'] ] ] = []
switch (process['CONFIG']['LOCAL']['OS']['PLATFORM']) {
case 'linux':
@ -157,65 +157,31 @@ switch (process['CONFIG']['LOCAL']['OS']['PLATFORM']) {
switch (sw_source_map[ process['CONFIG']['LOCAL']['OS']['DISTRO'] ]) {
case 'DEB':
let dpkg_json_obj = dpkg_list_to_json( childProcess.execSync(cmd_sw_list_map[ process['CONFIG']['LOCAL']['OS']['DISTRO'] ], { encoding: 'utf8' }) )
for (sw in dpkg_json_obj['json_obj']) {
am_data['SOURCE']['SW'][ sw_source_map[ process['CONFIG']['LOCAL']['OS']['DISTRO'] ] ].push(dpkg_json_obj['json_obj'][sw])
}
am_data['SOURCE']['SW'][ sw_source_map[ process['CONFIG']['LOCAL']['OS']['DISTRO'] ] ] = dpkg_list_to_json( childProcess.execSync(cmd_sw_list_map[ process['CONFIG']['LOCAL']['OS']['DISTRO'] ], { encoding: 'utf8' }) )
// am_data['SOURCE']['SW'][ sw_source_map[ process['CONFIG']['LOCAL']['OS']['DISTRO'] ] ] = []
// let dpkg_json_obj = dpkg_list_to_json( childProcess.execSync(cmd_sw_list_map[ process['CONFIG']['LOCAL']['OS']['DISTRO'] ], { encoding: 'utf8' }) )
// for (sw in dpkg_json_obj['json_obj']) {
// am_data['SOURCE']['SW'][ sw_source_map[ process['CONFIG']['LOCAL']['OS']['DISTRO'] ] ].push(dpkg_json_obj['json_obj'][sw])
// }
break;
case 'RPM':
am_data['SOURCE']['SW'][ sw_source_map[ process['CONFIG']['LOCAL']['OS']['DISTRO'] ] ] = rpm_list_to_json( childProcess.execSync(cmd_sw_list_map[ process['CONFIG']['LOCAL']['OS']['DISTRO'] ], { encoding: 'utf8' }) )
// am_data['SOURCE']['SW'][ sw_source_map[ process['CONFIG']['LOCAL']['OS']['DISTRO'] ] ] = []
// let rpm_json_obj = rpm_list_to_json( childProcess.execSync(cmd_sw_list_map[ process['CONFIG']['LOCAL']['OS']['DISTRO'] ], { encoding: 'utf8' }) )
// for (sw in rpm_json_obj['json_obj']) {
// am_data['SOURCE']['SW'][ sw_source_map[ process['CONFIG']['LOCAL']['OS']['DISTRO'] ] ].push(rpm_json_obj['json_obj'][sw])
// }
break;
default:
console.log('ERROR: Unsupported Distribution: ' + process['CONFIG']['LOCAL']['OS']['DISTRO'])
process.exit(1)
}
// switch (process['CONFIG']['LOCAL']['OS']['DISTRO']) {
// case 'CentOS':
// am_data['SOURCE']['YUM'] = {}
// cmd_sw_list = 'rpm -qa'
// sw_list = childProcess.execSync(cmd_sw_list, { encoding: 'utf8' })
//
// break;
// case 'CentOS Linux':
// am_data['SOURCE']['YUM'] = {}
// cmd_sw_list = 'rpm -qa'
// sw_list = childProcess.execSync(cmd_sw_list, { encoding: 'utf8' })
//
// break;
// case 'Debian GNU/Linux':
// am_data['SOURCE']['APT'] = {}
// cmd_sw_list = 'rpm -qa'
// sw_list = childProcess.execSync(cmd_sw_list, { encoding: 'utf8' })
//
// break;
// case 'Linux Mint':
// am_data['SOURCE']['APT'] = {}
// cmd_sw_list = 'rpm -qa'
// sw_list = childProcess.execSync(cmd_sw_list, { encoding: 'utf8' })
//
// break;
// case 'LinuxMint':
// am_data['SOURCE']['APT'] = {}
// cmd_sw_list = 'rpm -qa'
// sw_list = childProcess.execSync(cmd_sw_list, { encoding: 'utf8' })
//
// break;
// case 'Raspbian GNU/Linux':
// am_data['SOURCE']['APT'] = {}
// cmd_sw_list = 'rpm -qa'
// sw_list = childProcess.execSync(cmd_sw_list, { encoding: 'utf8' })
//
// break;
// default:
// console.log('ERROR: Unsupported Linux Distro: ' + process['CONFIG']['LOCAL']['OS']['DISTRO'])
// process.exit(1)
// }
break;
case 'darwin':
console.log('Platform: ' + process['CONFIG']['LOCAL']['OS']['PLATFORM'])
console.log('Distro: ' + process['CONFIG']['LOCAL']['OS']['DISTRO'] + '(' + process['CONFIG']['LOCAL']['OS']['DISTRO_VERSION'] + ')')
// console.log('Platform: ' + process['CONFIG']['LOCAL']['OS']['PLATFORM'])
// console.log('Distro: ' + process['CONFIG']['LOCAL']['OS']['DISTRO'] + '(' + process['CONFIG']['LOCAL']['OS']['DISTRO_VERSION'] + ')')
am_data['SOURCE']['SW'][ sw_source_map[ process['CONFIG']['LOCAL']['OS']['DISTRO'] ] ] = JSON.parse(childProcess.execSync(cmd_sw_list_map[ process['CONFIG']['LOCAL']['OS']['DISTRO'] ], { encoding: 'utf8' }))
break;
@ -233,13 +199,34 @@ switch (process['CONFIG']['LOCAL']['OS']['PLATFORM']) {
ts = tell_time()
am_data['ITAM']['ENDTIME'] = ts['UTC']['ISO8601']
am_data['ITAM']['ELAPSED_SEC'] = (Number(ts['UTC']['EPOCH']) - starttime)
console.log ("Runtime: " + am_data['ITAM']['ELAPSED_SEC'] + ' seconds')
console.log ("\nRuntime: " + Math.round(am_data['ITAM']['ELAPSED_SEC']) + ' seconds')
iatm_upload_data(am_data)
// ------------ Functions Libraries --------------------//
function rpm_list_to_json(rpm_list) {
let json_obj = []
let lines = rpm_list.split(/\n/)
let rpm_info_regx = RegExp(/^(.*):\s+(.*)/)
for (l in lines) {
if (lines[l]) {
cmd_rpm_info = '/usr/bin/rpm -qi ' + lines[l]
let rpm_info = childProcess.execSync(cmd_rpm_info, { encoding: 'utf8' })
let rpm_info_lines = rpm_info.split(/\n/)
let pkg = {}
for (rl in rpm_info_lines) {
if (mch = rpm_info_lines[rl].match(rpm_info_regx)) {
pkg[ mch[1].replace(/\s+/, '') ] = mch[2]
}
}
json_obj.push(pkg)
}
}
return json_obj
}
function dpkg_list_to_json(dpkg_list) {
let json_obj = []
@ -248,7 +235,7 @@ function dpkg_list_to_json(dpkg_list) {
let pkg_info_regx = RegExp(/^(.*):\s+(.*)/)
let apt_history_regx = RegExp(/^(.*):\s+(.*)/)
process.stdout.write('Apt Pkg Progress: [0/' + lines.length + '] 0 % ')
process.stdout.write('Processing Apt Pkgs: [0/' + lines.length + '] 0 % ')
// Extract Apt Log - /var/log/apt/history.log.*.gz
let cmc_extract_apt_history = 'zcat /var/log/apt/history.log.*.gz > /var/tmp/apt-history.log'
@ -271,7 +258,7 @@ function dpkg_list_to_json(dpkg_list) {
if (mch = lines[l].match(dpkg_list_regx)) {
if (mch[1] != "||/") {
let pkg = {}
pkg['STATUS'] = mch[1]
pkg['SW_STATUS'] = mch[1]
pkg['SW_NAME'] = mch[2]
pkg['SW_VERSION'] = mch[3]
pkg['SW_ARCH'] = mch[4]
@ -286,7 +273,7 @@ function dpkg_list_to_json(dpkg_list) {
if ( (l % 10) == 0 ) {
process.stdout.clearLine();
process.stdout.cursorTo(0);
process.stdout.write('Apt Pkg Progress: [' + l + '/' + lines.length + '] ' + Math.round(100 * l / Number(lines.length)) + ' % ')
process.stdout.write('Processing Apt Pkgs: [' + l + '/' + lines.length + '] ' + Math.round(100 * l / Number(lines.length)) + ' % ')
}
if (pmch = pkg_info_lines[pl].match(pkg_info_regx)) {
@ -318,7 +305,7 @@ function dpkg_list_to_json(dpkg_list) {
// console.log(JSON.stringify(json_obj, null, 2))
return {json_obj}
return json_obj
// return {}
}
@ -328,7 +315,6 @@ function iatm_upload_data(data) {
itam_upload_url = process['CONFIG']['GLOBAL']['SERVER_BASE_URL'] + '/api/upload/?ITAM_DATA=' + encodeURIComponent(JSON.stringify(data))
console.log ("")
console.log ('Data Payload: ' + itam_upload_url.length + ' Bytes')
request({
@ -337,7 +323,11 @@ function iatm_upload_data(data) {
if (!error && response.statusCode === 200) {
// console.log (JSON.stringify(data, null, 2))
// console.log (encodeURIComponent(JSON.stringify(data)))
console.log (' Uploaded: ' + body)
if (body) {
console.log ('Data Upload: SUCCESS')
} else {
console.log ('Data Upload: FAILED')
}
} else {
console.log ('ERROR: Failed to upload data' )
}

3
skqitam-client/package.json
View File

@ -1,8 +1,9 @@
{
"name": "skqitam-client",
"version": "0.0.4",
"version_date": "2021-06-11",
"version_date": "2021-06-16",
"description": "Sikuliaq IT Asset Manager Client Data Collector",
"copyright": "University of Alaska Fairbanks - College of Fisheries and Ocean Science - R/V Sikuliaq",
"main": "skqitam-client.js",
"dependencies": {
"is-admin": "^3.0.0",

2
start-server.sh
View File

@ -15,7 +15,7 @@ npm_path="$rundir/nodejs/node-$node_ver-$os-$arch/bin/npm"
export PATH="$rundir/nodejs/node-$node_ver-$os-$arch/bin:"$PATH
# My need to grow if client Payload get larger
max_http_header_size='40000000'
max_http_header_size='400000000'
if [ -x "$node_path" ]; then
$node_path --max-http-header-size $max_http_header_size $rundir/index.js

2
web/root/mkdocs.yml
View File

@ -5,7 +5,7 @@ copyright: <p class="small">Copyright &copy; 2021 <a target="_blank" href="https
use_directory_urls: false
extra:
version: 0.0.4 2021-06-15
version: 0.0.4 2021-06-16
repo_url: https://github.alaska.edu/skq/skq-it-am.git
repo_name: <span class="fab fa-git-square"></span>

2
web/root/site/404.html
View File

@ -136,7 +136,7 @@
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

18
web/root/site/bootstrap.html
View File

@ -122,7 +122,7 @@
</ul>
<h3 id="examples">Examples</h3>
<h5 id="alerts">Alerts</h5>
<pre><code class="markdown">&lt;div class=&quot;alert alert-primary&quot; role=&quot;alert&quot;&gt;
<pre><code class="language-markdown">&lt;div class=&quot;alert alert-primary&quot; role=&quot;alert&quot;&gt;
This is a primary alert—check it out!
&lt;/div&gt;
&lt;div class=&quot;alert alert-secondary&quot; role=&quot;alert&quot;&gt;
@ -147,41 +147,33 @@
This is a dark alert—check it out!
&lt;/div&gt;
</code></pre>
<div class="alert alert-primary" role="alert">
This is a primary alert—check it out!
</div>
<div class="alert alert-secondary" role="alert">
This is a secondary alert—check it out!
</div>
<div class="alert alert-success" role="alert">
This is a success alert—check it out!
</div>
<div class="alert alert-danger" role="alert">
This is a danger alert—check it out!
</div>
<div class="alert alert-warning" role="alert">
This is a warning alert—check it out!
</div>
<div class="alert alert-info" role="alert">
This is a info alert—check it out!
</div>
<div class="alert alert-light" role="alert">
This is a light alert—check it out!
</div>
<div class="alert alert-dark" role="alert">
This is a dark alert—check it out!
</div>
<h5 id="buttons">Buttons</h5>
<pre><code class="markdown">&lt;button type=&quot;button&quot; class=&quot;btn btn-primary&quot;&gt;Primary&lt;/button&gt;
<pre><code class="language-markdown">&lt;button type=&quot;button&quot; class=&quot;btn btn-primary&quot;&gt;Primary&lt;/button&gt;
&lt;button type=&quot;button&quot; class=&quot;btn btn-secondary&quot;&gt;Secondary&lt;/button&gt;
&lt;button type=&quot;button&quot; class=&quot;btn btn-success&quot;&gt;Success&lt;/button&gt;
&lt;button type=&quot;button&quot; class=&quot;btn btn-danger&quot;&gt;Danger&lt;/button&gt;
@ -191,7 +183,6 @@
&lt;button type=&quot;button&quot; class=&quot;btn btn-dark&quot;&gt;Dark&lt;/button&gt;
&lt;button type=&quot;button&quot; class=&quot;btn btn-link&quot;&gt;Link&lt;/button&gt;
</code></pre>
<p><button type="button" class="btn btn-primary">Primary</button>
<button type="button" class="btn btn-secondary">Secondary</button>
<button type="button" class="btn btn-success">Success</button>
@ -203,9 +194,8 @@
<button type="button" class="btn btn-link">Link</button></p>
<h6 id="link-buttons">Link Buttons</h6>
<p>You can also turn HTML Links into Buttons</p>
<pre><code class="markdown">&lt;a class=&quot;btn btn-primary&quot; href=&quot;&quot;&gt;HTML Link&lt;/a&gt;
<pre><code class="language-markdown">&lt;a class=&quot;btn btn-primary&quot; href=&quot;&quot;&gt;HTML Link&lt;/a&gt;
</code></pre>
<p><a class="btn btn-primary" href="">HTML Link</a></p></div>
</div>
</div>
@ -223,7 +213,7 @@
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

8
web/root/site/build.html
View File

@ -115,17 +115,15 @@
<div class="col-md-12" role="main" style="top: -50px;">
<h2 id="building-the-website">Building the Website</h2>
<pre><code class="bash">[$] cd skq-mkdocs-templates
<pre><code class="language-bash">[$] cd skq-mkdocs-templates
</code></pre>
<p>To rebuild a clean HTML <code>site</code> directory run <code>mkdocs build --clean</code></p>
<pre><code class="bash">[$] mkdocs build --clean
<pre><code class="language-bash">[$] mkdocs build --clean
WARNING - Config value: 'version'. Warning: Unrecognised configuration name: version
PDF export is disabled (set environment variable ENABLE_PDF_EXPORT to 1 to enable)
INFO - Cleaning site directory
INFO - Building documentation to directory: /home/jehaverlack/Devel/Sikuliaq/docs/skq-mkdocs-template/site
</code></pre>
<div class="alert alert-info">
Each time you edit the site source content files you will need to run the <code>mkdocs build --clean</code> command to rebuild the <code>site</code> directory and test your edits.
</div>
@ -148,7 +146,7 @@ Each time you edit the site source content files you will need to run the <code>
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

11
web/root/site/cloning.html
View File

@ -120,21 +120,18 @@ A UA Github (<a href="https://github.alaska.edu">https://github.alaska.edu</a>)
</div>
<h4 id="git-clone">Git clone</h4>
<pre><code class="bash">git clone https://github.alaska.edu/skq/skq-mkdocs-template.git
<pre><code class="language-bash">git clone https://github.alaska.edu/skq/skq-mkdocs-template.git
</code></pre>
<h4 id="download-zip">Download Zip</h4>
<p>Or <a href="https://github.alaska.edu/skq/skq-mkdocs-template/archive/master.zip">download as a zip</a> file.</p>
<h3 id="shipside-git-repository">Shipside Git Repository</h3>
<p>No login required</p>
<h4 id="git-clone_1">Git clone</h4>
<pre><code class="bash">git clone https://git.sikuliaq.alaska.edu/scm/git/skq/skq-mkdocs-template
<pre><code class="language-bash">git clone https://git.sikuliaq.alaska.edu/scm/git/skq/skq-mkdocs-template
</code></pre>
<h3 id="files-and-directories">Files and Directories</h3>
<pre><code class="bash">cd skq-mkdocs-templates
<pre><code class="language-bash">cd skq-mkdocs-templates
</code></pre>
<h4 id="inputs">Inputs</h4>
<ul>
<li><strong>mkdocs.yml</strong> - master Configuration File</li>
@ -163,7 +160,7 @@ A UA Github (<a href="https://github.alaska.edu">https://github.alaska.edu</a>)
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

54
web/root/site/code.html
View File

@ -120,88 +120,82 @@
</div>
<h3 id="plain-text">Plain Text</h3>
<pre><code class="plaintext">Hello World
<pre><code class="language-plaintext">Hello World
</code></pre>
<h3 id="html">HTML</h3>
<pre><code class="html">&lt;h2&gt;Hello World&lt;/h2&gt;
<pre><code class="language-html">&lt;h2&gt;Hello World&lt;/h2&gt;
</code></pre>
<h3 id="javascript">JavaScript</h3>
<pre><code class="javascript">console.log(&quot;Hello World&quot;)
<pre><code class="language-javascript">console.log(&quot;Hello World&quot;)
</code></pre>
<h3 id="css">CSS</h3>
<pre><code class="css">.helloworld {
<pre><code class="language-css">.helloworld {
color: #567;
}
</code></pre>
<h3 id="markdown">Markdown</h3>
<pre><code class="markdown">## Hello World
<pre><code class="language-markdown">## Hello World
</code></pre>
<h3 id="bash">Bash</h3>
<pre><code class="bash">#!/bin/bash
<pre><code class="language-bash">#!/bin/bash
echo &quot;Hello World&quot;
</code></pre>
<h3 id="json">JSON</h3>
<pre><code class="json">{
<pre><code class="language-json">{
&quot;Hello&quot;:&quot;World&quot;
}
</code></pre>
<hr />
<h4 id="marddown-code-highlight-source">Marddown Code Highlight Source</h4>
<div class="alert alert-warning">
<pre><code class="markdown">
### Plain Text
&#96&#96&#96 {.plaintext}
&#96;&#96;&#96; {.plaintext}
Hello World
&#96&#96&#96
&#96;&#96;&#96;
### HTML
&#96&#96&#96 {.html}
&#60h2&#62Hello World&#60/h2&#62
&#96&#96&#96
&#96;&#96;&#96; {.html}
&#60;h2&#62;Hello World&#60;/h2&#62;
&#96;&#96;&#96;
### JavaScript
&#96&#96&#96 {.javascript}
&#96;&#96;&#96; {.javascript}
console.log("Hello World")
&#96&#96&#96
&#96;&#96;&#96;
### CSS
&#96&#96&#96 {.css}
&#96;&#96;&#96; {.css}
.helloworld {
color: #567;
}
&#96&#96&#96
&#96;&#96;&#96;
### Markdown
&#96&#96&#96 {.markdown}
&#96;&#96;&#96; {.markdown}
## Hello World
&#96&#96&#96
&#96;&#96;&#96;
### Bash
&#96&#96&#96 {.bash}
&#96;&#96;&#96; {.bash}
#!/bin/bash
echo "Hello World"
&#96&#96&#96
&#96;&#96;&#96;
### JSON
&#96&#96&#96 {.json}
&#96;&#96;&#96; {.json}
{
"Hello":"World"
}
&#96&#96&#96
&#96;&#96;&#96;
</code></pre>
</div></div>
</div>
@ -220,7 +214,7 @@ echo "Hello World"
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

2
web/root/site/contact.html
View File

@ -145,7 +145,7 @@
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

5
web/root/site/editing.html
View File

@ -127,7 +127,7 @@
To modify the navigation menu find the following section in <code>mkdocs.yml</code>. NOTE the <b>top level nav menu</b> items such as <b>Setup</b>, <b>Features</b>, and <b>About</b>. And the paged under each top level nav item.
</div>
<pre><code class="yml">nav:
<pre><code class="language-yml">nav:
- &lt;span class=&quot;fas fa-home&quot;&gt;&lt;/span&gt;: index.md
- Setup:
- Install: install.md
@ -150,7 +150,6 @@
- About:
- Contact: contact.md
</code></pre>
<div class="alert alert-info">
See how the HTML renders a <a target="_blank" href="https://getbootstrap.com/docs/3.3/components/#navbar-default">Bootstrap</a> menu.
</div>
@ -184,7 +183,7 @@ Markdown files can contain inline HTML, or pure Markdown code.
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

11
web/root/site/equations.html
View File

@ -122,18 +122,16 @@ Markdown supports inline [LaTeX](https://en.wikipedia.org/wiki/LaTeX) equations
<h4 id="inline-equations">Inline Equations</h4>
<p>Inline LaTeX starts and ends with <code>\(</code> LaTex Code <code>\)</code></p>
<h5 id="code">Code</h5>
<pre><code class="latex">The square root of 2 is \(\sqrt{2} = 1.141421....\).
<pre><code class="language-latex">The square root of 2 is \(\sqrt{2} = 1.141421....\).
</code></pre>
<p>The square root of 2 is <script type="math/tex">\sqrt{2} = 1.141421....</script>.</p>
<hr />
<h4 id="centered-equations">Centered Equations</h4>
<p>To center an equation on the page use:</p>
<p><code>\[</code> LaTex Code <code>\]</code></p>
<h5 id="code_1">Code</h5>
<pre><code class="latex">\[\sqrt{2} = 1.141421....\]
<pre><code class="language-latex">\[\sqrt{2} = 1.141421....\]
</code></pre>
<p>
<script type="math/tex; mode=display">\sqrt{2} = 1.141421....</script>
</p>
@ -142,9 +140,8 @@ Markdown supports inline [LaTeX](https://en.wikipedia.org/wiki/LaTeX) equations
<p>To left justify an equation use:</p>
<p><code>\(</code> LaTex Code <code>\)</code></p>
<h5 id="code_2">Code</h5>
<pre><code class="latex">\(\sqrt{2} = 1.141421....\)
<pre><code class="language-latex">\(\sqrt{2} = 1.141421....\)
</code></pre>
<p>
<script type="math/tex">\sqrt{2} = 1.141421....</script>
</p>
@ -219,7 +216,7 @@ Markdown supports inline [LaTeX](https://en.wikipedia.org/wiki/LaTeX) equations
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

5
web/root/site/footnotes.html
View File

@ -116,13 +116,12 @@
<h2 id="footnotes">Footnotes</h2>
<p>To use the footnotes plugin <sup id="fnref:1"><a class="footnote-ref" href="#fn:1">1</a></sup>, simply include <code>[^footnoteid]</code> inline in your text, and <code>[^footnoteid]:</code> at the end of your markdown file. Also be sure to enable the footnote plugin in your <code>mkdocs.yml</code> file.</p>
<pre><code class="markdown">To use the footnotes plugin [^1], simply include ...
<pre><code class="language-markdown">To use the footnotes plugin [^1], simply include ...
...
[^1]: [Footnotes Plugin](https://www.markdownguide.org/extended-syntax#footnotes)
</code></pre>
<div class="footnote">
<hr />
<ol>
@ -147,7 +146,7 @@
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

5
web/root/site/icons.html
View File

@ -129,7 +129,6 @@
<p>To use an FA Icon, embed it as a <code>&lt;span&gt;</code> element with the appropriate class.</p>
<pre><code>&lt;span class=&quot;fas fa-user&quot;&gt;&lt;/span&gt;
</code></pre>
<p><span class="fas fa-user"></span></p>
<h4 id="example-1">Example 1</h4>
<p>Search for <strong><em>question</em></strong> on the <a href="https://fontawesome.com/icons?d=gallery&amp;s=brands,regular,solid&amp;m=free">Font Awesome</a> icon page. You will see 3 search interesting results:
@ -141,7 +140,6 @@
- &lt;span class=&quot;fas fa-question-circle&quot;&gt;&lt;/span&gt; Solid Question Circle
- &lt;span class=&quot;far fa-question-circle&quot;&gt;&lt;/span&gt; Regular Question Circle
</code></pre>
<ul>
<li><span class="fas fa-question"></span> Solid Question Mark</li>
<li><span class="fas fa-question-circle"></span> Solid Question Circle</li>
@ -153,7 +151,6 @@
- &lt;span class=&quot;fab fa-apple&quot;&gt;&lt;/span&gt; Mac
- &lt;span class=&quot;fab fa-windows&quot;&gt;&lt;/span&gt; Windows
</code></pre>
<ul>
<li><span class="fab fa-linux"></span> Linux</li>
<li><span class="fab fa-apple"></span> Mac</li>
@ -175,7 +172,7 @@
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

2
web/root/site/index.html
View File

@ -174,7 +174,7 @@
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

16
web/root/site/install.html
View File

@ -115,9 +115,10 @@
<div class="col-md-12" role="main" style="top: -50px;">
<h2 id="installing-requirements">Installing Requirements</h2>
<p><div class="alert alert-info">
<div class="alert alert-info">
The following tools can be installed and used cross platform on <b>Windows</b>, <b>Mac</b> and <b>Linux</b> computers to build <b>MkDocs</b> websites.
</div></p>
</div>
<div class="alert alert-warning">
You may need to adapt the following notes for you operating system platform.
</div>
@ -128,13 +129,12 @@
<li><a href="https://www.python.org/">Python</a> Version 3 recommended</li>
</ul>
<h5 id="testing-python-version">Testing Python Version</h5>
<pre><code class="bash">[$] python3 --version
<pre><code class="language-bash">[$] python3 --version
Python 3.6.8
[$] pip3 --version
pip 9.0.3 from /usr/lib/python3.6/site-packages (python 3.6)
</code></pre>
<h3 id="mkdocs">MkDocs</h3>
<ul>
<li><a href="https://www.mkdocs.org/">MkDocs</a> Website</li>
@ -144,18 +144,16 @@ pip 9.0.3 from /usr/lib/python3.6/site-packages (python 3.6)
</div>
<h4 id="installing-mkdocs-and-common-plugins">Installing MkDocs and common plugins</h4>
<pre><code class="bash">sudo pip install mkdocs
<pre><code class="language-bash">sudo pip install mkdocs
sudo pip install mkdocs-pdf-export-plugin
sudo pip install mkdocs-bootstrap
sudo pip install python-markdown-math
sudo pip install https://github.com/mitya57/python-markdown-math/archive/master.zip
</code></pre>
<h5 id="testing-mkdocs-version">Testing MkDocs Version</h5>
<pre><code class="bash">[$] mkdocs --version
<pre><code class="language-bash">[$] mkdocs --version
mkdocs, version 1.1 from /usr/local/lib/python3.6/site-packages/mkdocs (Python 3.6)
</code></pre>
<p>For windows you can omit <code>sudo</code> in the above commands.</p>
<div class="alert alert-warning">
NOTE: You will need MkDocs version 1.1 to work with this template. If you have an older version try upgrading with:
@ -189,7 +187,7 @@ mkdocs, version 1.1 from /usr/local/lib/python3.6/site-packages/mkdocs (Python 3
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

2
web/root/site/license.html
View File

@ -149,7 +149,7 @@
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

12
web/root/site/menu.html
View File

@ -115,11 +115,12 @@
<div class="col-md-12" role="main" style="top: -50px;">
<h2 id="menu-navigation">Menu navigation</h2>
<p>As described on the <a href="editing.html">Editing</a> page
<p>As described on the <a href="editing.html">Editing</a> page</p>
<div class="alert alert-info">
To modify the navigation menu find the following section in <code>mkdocs.yml</code>.
</div></p>
<pre><code class="yml">nav:
</div>
<pre><code class="language-yml">nav:
- &lt;span class=&quot;fas fa-home&quot;&gt;&lt;/span&gt;: index.md
- Setup:
- Install: install.md
@ -130,12 +131,11 @@
- Swipe Nav: swipe.md
-...
</code></pre>
<div class="alert alert-info">
However both top and sub nav menu items can also be both Markdown or URL links. For example:
</div>
<pre><code class="yml">nav:
<pre><code class="language-yml">nav:
- Home: index.md
- Sikuliaq: https://www.sikuliaq.alaska.edu
- UAF:
@ -158,7 +158,7 @@ However both top and sub nav menu items can also be both Markdown or URL links.
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

14
web/root/site/optional.html
View File

@ -116,35 +116,31 @@
<h2 id="optional-recommended-tools">Optional Recommended Tools</h2>
<p>MkDocs provides a test webserver that can be used to test the static HTML website.</p>
<pre><code class="bash">mkdocs serve
<pre><code class="language-bash">mkdocs serve
</code></pre>
<p>However you might prefer the Node.js http-server for this purpose.</p>
<h3 id="nodejs">Node.js</h3>
<ul>
<li><a href="https://nodejs.org/en/">Node.js</a></li>
</ul>
<h5 id="or-via-nvm-no-admin-privs-needed">or via <a href="https://github.com/nvm-sh/nvm#installing-and-updating">NVM</a> (No Admin Privs Needed)</h5>
<pre><code class="bash">curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.2/install.sh | bash
<pre><code class="language-bash">curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.2/install.sh | bash
nvm install --lts
</code></pre>
<pre><code class="bash">[$] node --version
<pre><code class="language-bash">[$] node --version
v12.14.1
[$] npm --version
6.13.4
</code></pre>
<h3 id="http-server">http-server</h3>
<p>(Requires Node.js)</p>
<ul>
<li><a href="https://github.com/http-party/http-server#readme">http-server</a></li>
</ul>
<pre><code class="bash">npm install --global http-server
<pre><code class="language-bash">npm install --global http-server
</code></pre>
<h3 id="atom-editor">Atom Editor</h3>
<ul>
<li><a href="https://atom.io/">https://atom.io/</a></li>
@ -173,7 +169,7 @@ v12.14.1
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

5
web/root/site/pdf.html
View File

@ -121,14 +121,13 @@
</ul>
<h4 id="enable-the-plugin">Enable the Plugin</h4>
<p>In your <code>mkdocs.yml</code> Config File</p>
<pre><code class="yml">plugins:
<pre><code class="language-yml">plugins:
- pdf-export:
verbose: true
media_type: print
combined: true
combined_output_path: pdf/skq-docs.pdf
</code></pre>
<div class="alert alert-warning">
Not all HTML code renders well as PDF.
</div>
@ -152,7 +151,7 @@
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

4
web/root/site/search.html
View File

@ -123,7 +123,7 @@
To enable site <b>Search</b> add the <code>- search</code> to the <code>mkdocs.yml</code> plugins section.
</div>
<pre><code class="yml">plugins:
<pre><code class="language-yml">plugins:
- search
</code></pre></div>
</div>
@ -142,7 +142,7 @@
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

8
web/root/site/sitemap.xml
View File

@ -1,19 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url>
<loc>None</loc>
<lastmod>2021-06-15</lastmod>
<lastmod>2021-06-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-06-15</lastmod>
<lastmod>2021-06-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-06-15</lastmod>
<lastmod>2021-06-17</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2021-06-15</lastmod>
<lastmod>2021-06-17</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

BIN
web/root/site/sitemap.xml.gz
View File

4
web/root/site/swipe.html
View File

@ -125,7 +125,7 @@ Swipe navigation is not a feature of MkDocs but is a custom modification include
<h3 id="customjsswipenavjs">custom/js/swipenav.js</h3>
<p>For details see the following JavaScript code.</p>
<pre><code class="javascript">var links = document.getElementsByTagName(&quot;a&quot;);
<pre><code class="language-javascript">var links = document.getElementsByTagName(&quot;a&quot;);
for (l in links) {
if (String(links[l].innerHTML).match(/fa-arrow-left.*Previous/)) {
@ -168,7 +168,7 @@ $(&quot;body&quot;).on('swiperight', function(e) {
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

11
web/root/site/test.html
View File

@ -115,9 +115,8 @@
<div class="col-md-12" role="main" style="top: -50px;">
<h2 id="testing-the-site">Testing the Site</h2>
<pre><code class="bash">[$] cd skq-mkdocs-templates
<pre><code class="language-bash">[$] cd skq-mkdocs-templates
</code></pre>
<div class="alert alert-info">
There is more than one way to test a mkdocs website.
</div>
@ -131,7 +130,7 @@ There is more than one way to test a mkdocs website.
</div>
<h3 id="run-the-mkdocs-serve-test-server">Run the <code>mkdocs serve</code> test server</h3>
<pre><code class="bash">[$] mkdocs serve
<pre><code class="language-bash">[$] mkdocs serve
INFO - Building documentation...
PDF export is disabled (set environment variable ENABLE_PDF_EXPORT to 1 to enable)
INFO - Cleaning site directory
@ -140,7 +139,6 @@ INFO - Cleaning site directory
[I 200208 15:58:49 handlers:64] Start detecting changes
[I 200208 15:59:08 handlers:135] Browser Connected: http://127.0.0.1:8000/
</code></pre>
<ul>
<li>Point your browser to: <a href="http://127.0.0.1:8000">http://127.0.0.1:8000</a></li>
</ul>
@ -150,14 +148,13 @@ INFO - Cleaning site directory
</ul>
<h3 id="run-the-http-server-test-server">Run the <code>http-server</code> test server</h3>
<p>See: <a href="optional.html">Optional Tools</a> to install.</p>
<pre><code class="bash">[$ skq-mkdocs-template] http-server site
<pre><code class="language-bash">[$ skq-mkdocs-template] http-server site
Starting up http-server, serving site
Available on:
http://127.0.0.1:8080
http://10.1.0.242:8080
Hit CTRL-C to stop the server
</code></pre>
<p>Point your browser to:</p>
<ul>
<li><a href="http://127.0.0.1:8080">http://127.0.0.1:8080</a></li>
@ -186,7 +183,7 @@ In modern web browsers (Firefox, Chrome, etc) you can right click in the backgro
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

5
web/root/site/version.html
View File

@ -119,10 +119,9 @@
A custom site <b>version</b> date has been added to the <code>mkdocs.yml</code> configuration file.
</div>
<pre><code class="yml">extra:
<pre><code class="language-yml">extra:
version: 2020-02-08
</code></pre>
<p>The <strong>Version</strong> is rendered in the footer of all MkDocs site page.</p>
<p><a href="img/Version.png"><img src="img/Version.png" class="img-responsive img-rounded" style="width: 600px;" alt="MenuNaV" ></a></p></div>
</div>
@ -141,7 +140,7 @@ A custom site <b>version</b> date has been added to the <code>mkdocs.yml</code>
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

2
web/root/site/versions.html
View File

@ -147,7 +147,7 @@
<p class="small"><p class="small">Copyright &copy; 2021 <a target="_blank" href="https://www.uaf.edu">University of Alaska Fairbanks</a> <a target="_blank" href="https://www.uaf.edu/cfos">College of Fisheries and Ocean Sciences</a> - <a target="_blank" href="https://www.sikuliaq.alaska.edu"><i>R/V Sikuliaq</i></a></p></p>
<p class="small">For questions or comments regarding this page, contact <a href="mailto:uaf-skq-science-support@alaska.edu">uaf-skq-science-support@alaska.edu</a></p>
<p class="small">Version: 0.0.4 2021-06-15</p>
<p class="small">Version: 0.0.4 2021-06-16</p>
<p class="small">Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>

Write Preview
Loading…
Cancel
Save