docs: update content

.github/workflows/node.js-ci.yml

@@ -1,7 +1,7 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+# Test and build your Hyas project
+# For more information see: https://henkverlinde.com/continuous-integration-workflow-for-your-hyas-project/
 
-name: CI
+name: Hyas CI
 
 on:
   push:

.gitignore

@@ -1,5 +1,4 @@
 functions
 node_modules
 public
-resources
-yarn-error.log
+resources

README.md

@@ -32,32 +32,34 @@ Nine reasons why you should use Doks:
 
 Make sure all dependencies have been installed:
 
-- [Hugo](https://gohugo.io/) >= 0.75.0/extended
+- [Hugo](https://gohugo.io/getting-started/installing/) >= 0.75.0/extended (needed for SCSS processing support)
 - [Node.js](https://nodejs.org/) >= 14.15.0 (needed to install npm packages and run commands)
 
 ## Get started
 
-Create a new Doks project:
+Have your Doks site in three steps:
+
+### 1. Create a new Doks project:
 
 ```bash
 git clone https://github.com/h-enk/doks.git my-doks-site
 ```
 
-Install npm packages:
+### 2. Install npm packages:
 
 ```bash
 npm install
 ```
 
-Start local development server:
+### 3. Start local development server:
 
 ```bash
 npm run start
 ```
 
-### Other commands
+## Other commands
 
-Doks comes with [commands for most used tasks](https://getdoks.org/docs/prologue/commands/).
+Doks comes with [commands](https://getdoks.org/docs/prologue/commands/) for common tasks.
 
 ## Quick start
 
@@ -67,7 +69,7 @@ Get your Doks site in 1 min.
 
 ## Example site
 
-👉 [doks.netlify.app](https://doks.netlify.app/)
+- [doks.netlify.app](https://doks.netlify.app/)
 
 ## Documentation
 

assets/js/app.js

@@ -148,3 +148,22 @@ Source:
   }
 
 }());
+
+/* eslint-disable */
+var clipboard = new ClipboardJS('.btn-clipboard');
+
+clipboard.on('success', function(e) {
+    /*
+    console.info('Action:', e.action);
+    console.info('Text:', e.text);
+    console.info('Trigger:', e.trigger);
+    */
+
+    e.clearSelection();
+});
+
+clipboard.on('error', function(e) {
+    console.error('Action:', e.action);
+    console.error('Trigger:', e.trigger);
+});
+/* eslint-enable */

assets/scss/common/_dark.scss

@@ -279,3 +279,7 @@ body.dark .alert-primary {
   background: $link-color-dark;
   color: $body-bg-dark;
 }
+
+body.dark .figure-caption {
+  color: $body-color-dark;
+}

assets/scss/common/_global.scss

@@ -2,7 +2,9 @@
 .blog .content,
 .page .content,
 .error404 .content,
-.docs.list .content {
+.docs.list .content,
+.tutorial.list .content,
+.showcase.list .content {
   padding-top: 1rem;
   padding-bottom: 3rem;
 }
@@ -112,14 +114,15 @@ body {
   @supports ((position: -webkit-sticky) or (position: sticky)) {
     .docs-links {
       max-height: calc(100vh - 4rem);
-      overflow-y: auto;
+      overflow-y: scroll;
     }
   }
 }
 
 @include media-breakpoint-up(lg) {
   .docs-links {
-    display: block !important;
+    display: block;
+    width: auto;
     margin-right: -1.5rem;
     padding-bottom: 4rem;
   }

assets/scss/layouts/_sidebar.scss

@@ -91,3 +91,20 @@ a.docs-link {
   text-decoration: none;
   color: $link-color;
 }
+
+.docs-links h3.sidebar-link,
+.page-links h3.sidebar-link {
+  text-transform: none;
+  font-size: $font-size-md;
+  font-weight: normal;
+}
+
+.docs-links h3.sidebar-link a,
+.page-links h3.sidebar-link a {
+  color: $body-color;
+}
+
+.docs-links h3.sidebar-link a:hover,
+.page-links h3.sidebar-link a:hover {
+  text-decoration: underline;
+}

config/_default/config.toml

@@ -88,3 +88,6 @@ rel  = "sitemap"
   [[module.mounts]]
     source = "node_modules/flexsearch"
     target = "assets/js/vendor/flexsearch"
+  [[module.mounts]]
+    source = "node_modules/clipboard"
+    target = "assets/js/vendor/clipboard"

config/_default/menus.toml

@@ -6,7 +6,7 @@
 
 [[docs]]
   name = "Help"
-  weight = 50
+  weight = 60
   identifier = "help"
   url = "/docs/help/"
 

config/_default/params.toml

@@ -1,36 +1,47 @@
+# Meta Data for SEO
+
+## Homepage
 title = "Doks"
 titleSeparator = "-"
 titleAddition = "Modern Documentation Theme"
 description = "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default."
 
+## Open Graph + Twitter Cards
 images = ["doks.png"]
-
 twitterSite = "henkverlinde"
 twitterCreator = "henkverlinde"
 facebookAuthor = "verlinde.henk"
 facebookPublisher = "verlinde.henk"
 ogLocale = "en_US"
 
+## JSON-LD
 schemaType = "Organization"
 schemaLogo = "logo-doks.png"
 schemaTwitter = "https://twitter.com/henkverlinde"
 schemaLinkedIn = "https://www.linkedin.com/in/henkverlinde/"
 schemaGitHub = "https://github.com/h-enk"
 schemaSection = "blog"
 
+## Sitelinks Search Box
 siteLinksSearchBox = false
 
+## Chrome Browser
 themeColor = "#fff"
 
+# Images
 quality = 85
 bgColor = "#fff"
 landscapePhotoWidths = [900, 800, 700, 600, 500]
 portraitPhotoWidths = [800, 700, 600, 500]
 lqipWidth = "20x"
 
+# Footer
 footer = "Powered by <a href=\"https://www.netlify.com/\">Netlify</a>, <a href=\"https://gohugo.io/\">Hugo</a>, and <a href=\"https://getdoks.org/\">Doks</a>"
 
+# Alert
 alert = false
 alertText = "Like Doks? <a class=\"alert-link\" href=\"https://github.com/h-enk/doks/stargazers\">Star on GitHub</a>. Thanks!</a>"
 
+# Edit Page
 docsRepo = "https://github.com/h-enk/doks"
+editPage = false

content/_index.md

@@ -7,3 +7,5 @@ lastmod: 2020-10-06T08:47:36+00:00
 draft: false
 images: []
 ---
+
+Like Doks? [Star on GitHub](https://github.com/h-enk/doks/stargazers)! ⭐️🙏

content/contributors/henk-verlinde/_index.md

@@ -7,6 +7,6 @@ draft: false
 images: []
 ---
 
-Creator of [Hyas](https://github.com/h-enk/hyas).
+Creator of Hyas.
 
 [@HenkVerlinde](https://twitter.com/henkverlinde)

content/docs/help/faq.md

@@ -9,7 +9,7 @@ images: []
 menu: 
   docs:
     parent: "help"
-weight: 540
+weight: 630
 toc: true
 ---
 
@@ -28,6 +28,11 @@ Please keep it in place.
 - open: `Enter`
 - close: `Esc`
 
+## Other documentation?
+
+- [Netlify](https://docs.netlify.com/)
+- [Hugo](https://gohugo.io/documentation/)
+
 ## Can I get support?
 
 Create a topic:

content/docs/help/how-to-update.md

@@ -0,0 +1,24 @@
+---
+title: "How to Update"
+description: "Regularly update the installed npm packages to keep your Doks website stable, usable, and secure."
+lead: "Regularly update the installed npm packages to keep your Doks website stable, usable, and secure."
+date: 2020-11-12T13:26:54+01:00
+lastmod: 2020-11-12T13:26:54+01:00
+draft: false
+images: []
+menu: 
+  docs:
+    parent: "help"
+weight: 610
+toc: true
+---
+
+{{< alert icon="💡" text="Learn more about <a href=\"https://docs.npmjs.com/about-semantic-versioning\">semantic versioning</a> and <a href=\"https://docs.npmjs.com/cli/v6/using-npm/semver#advanced-range-syntax\">advanced range syntax</a>." >}}
+
+## Update npm packages
+
+Bump the versions in the `devDependencies` section of `./package.json` to your liking, and run:
+
+```bash
+npm update
+```

content/docs/help/troubleshooting.md

@@ -0,0 +1,30 @@
+---
+title: "Troubleshooting"
+description: "Solutions to common problems."
+lead: "Solutions to common problems."
+date: 2020-11-12T15:22:20+01:00
+lastmod: 2020-11-12T15:22:20+01:00
+draft: false
+images: []
+menu: 
+  docs:
+    parent: "help"
+weight: 620
+toc: true
+---
+
+## Problems updating npm packages
+
+Delete the `./node_modules` folder, and run again:
+
+```bash
+npm install
+```
+
+## Problems with cache
+
+Delete the temporary directories:
+
+```bash
+npm run clean
+```