feat(docsy): Sync with Docsy v0.7.0 spec

Author: sylus

.github/workflows/gh-pages.yml

@@ -12,28 +12,35 @@ jobs:
     steps:
       - uses: actions/checkout@v2
         with:
-          submodules: recursive  # Fetch Hugo themes (true OR recursive)
-          fetch-depth: 0    # Fetch all history for .GitInfo and .Lastmod
+          submodules: recursive
+          fetch-depth: 0
 
       - name: Setup Hugo
         uses: peaceiris/actions-hugo@v2
         with:
-          hugo-version: '0.108.0'
+          hugo-version: '0.114.0'
           extended: true
 
       - name: Setup Node
         uses: actions/setup-node@v1
         with:
           node-version: '16.x'
 
+      - name: Cache dependencies
+        uses: actions/cache@v1
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+
       - run: npm install
 
       - name: Build
         run: hugo --environment production --minify
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
-        if: github.ref == 'refs/heads/main'
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./public

.gitignore

@@ -1,6 +1,6 @@
-/public
-resources/
 node_modules/
-package-lock.json
+/public
+/resources
+.DS_Store
 .hugo_build.lock
 _vendor

CODE_OF_CONDUCT.md

@@ -0,0 +1,15 @@
+([Français](#code-de-conduite))
+
+## Code of Conduct
+
+Drupal WxT follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
+
+Please review before contributing issues, pull requests, or joining the GitHub organization.
+
+______________________
+
+## Code de conduite
+
+Drupal WxT suit le [Code de conduite de la CNCF](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/fr.md).
+
+Veuillez passer en revue avant de contribuer à des problèmes, des demandes d'extraction ou de rejoindre l'organisation GitHub.

CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing
+
+([Français](#comment-contribuer))
+
+## How to Contribute
+
+Feel free to propose changes by creating Pull Requests. If you don't have write access, editing a file will create a Fork of this project for you to save your proposed changes to. Submitting a change to a file will write it to a new Branch in your Fork, so you can send a Pull Request.
+
+If this is your first time contributing on GitHub, don't worry! Let us know if you have any questions.
+
+### Security
+
+**Do not post any security issues on the public repository!** See [SECURITY.md](SECURITY.md)
+
+______________________
+
+## Comment contribuer
+
+Lorsque vous contribuez, veuillez également publier des commentaires et discuter des modifications que vous souhaitez apporter par l'entremise des enjeux (Issues).
+
+N'hésitez pas à proposer des modifications en créant des demandes de tirage (Pull Requests). Si vous n'avez pas accès au mode de rédaction, la modification d'un fichier créera une copie (Fork) de ce projet afin que vous puissiez enregistrer les modifications que vous proposez. Le fait de proposer une modification à un fichier l'écrira dans une nouvelle branche dans votre copie (Fork), de sorte que vous puissiez envoyer une demande de tirage (Pull Request).
+
+Si c'est la première fois que vous contribuez à GitHub, ne vous en faites pas! Faites-nous part de vos questions.
+
+### Sécurité
+
+**Ne publiez aucun problème de sécurité sur le dépôt publique!** Voir [SECURITY.md](SECURITY.md)

README.md

@@ -1,5 +1,71 @@
-# Drupal WxT
+# Website
 
-This Docsy derived project is hosted at **[https://drupalwxt.github.io](https://drupalwxt.github.io)**.
+[Docsy](https://github.com/google/docsy) is a Hugo theme for technical documentation sites, providing easy site navigation, structure, and more.
 
-> **[Docsy](https://github.com/google/docsy)** is a Hugo theme for technical documentation sites, providing easy site navigation, structure, and more.
+> This Docsy derived project is hosted at [https://drupalwxt.github.io/](https://drupalwxt.github.io/). You can find detailed theme instructions in the Docsy user guide: https://docsy.dev/docs/
+
+## Installing Hugo
+
+This repository is presently using Hugo extended 0.101.0 which is available at the bottom of its [release page](https://github.com/gohugoio/hugo/releases/tag/v0.101.0).
+
+## Cloning
+
+The following will give you a project that is set up and ready to use.
+
+The `hugo server` command builds and serves the site.
+
+If you just want to build the site, run `hugo` instead.
+
+```sh
+git clone https://github.com/drupalwxt/drupalwxt.github.io
+cd drupalwxt.github.io
+./dev.sh
+```
+
+The theme is included as part of a Hugo module:
+
+```sh
+▶ hugo mod graph
+project github.com/google/[email protected]+vendor
+project github.com/google/docsy/[email protected]+vendor
+project github.com/twbs/[email protected]+incompatible+vendor
+project github.com/FortAwesome/[email protected]+vendor
+```
+
+If you want to do SCSS edits and want to publish these, you need to install `PostCSS` (not needed for `hugo server`):
+
+```sh
+npm install
+```
+
+## Running the website locally
+
+Once you've cloned the site repo, from the repo root folder, run:
+
+```sh
+./dev.sh
+```
+
+## Linting
+
+To lint all Markdown files in a Node.js project (excluding dependencies), the following commands might be used:
+
+Windows CMD
+
+```sh
+markdownlint content/**/*.md --ignore node_modules --fix
+```
+
+Linux Bash
+
+```sh
+markdownlint 'content/**/*.md' --ignore node_modules --fix
+```
+
+## Acknowledgements
+
+Thanks to the following projects for showing us how to clearly architect a docsy project:
+
+* [Knative](https://knative.dev)
+* [Docsy Example](https://github.com/google/docsy-example)
+* [Cloud Platform User Guide](https://user-guide.cloud-platform.service.justice.gov.uk/#cloud-platform-user-guide)

SECURITY.md

@@ -0,0 +1,11 @@
+([Français](#sécurité))
+
+## Security
+
+**Do not post any security issues on the public repository!** Security vulnerabilities must be reported by email to `[email protected]`
+
+______________________
+
+## Sécurité
+
+**Ne publiez aucun problème de sécurité sur le dépôt publique!** Les vulnérabilités de sécurité doivent être signalées par courriel à `[email protected]`

assets/js/custom.js

@@ -0,0 +1,114 @@
+// Custom CSS
+
+// Main Navbar
+
+.td-navbar {
+  @extend .navbar;
+  @extend .navbar-expand;
+
+  background: $white !important;
+  border-bottom: 1px solid #284162 !important;
+
+  min-height: 4rem;
+  margin: 0;
+  z-index: 32;
+
+  .navbar-brand {
+    svg {
+      display: inline-block;
+      height: 50px;
+      width: auto;
+      margin-right: 10px;
+    }
+  }
+}
+
+// Search
+
+.td-search {
+  // Search input element
+  &__input {
+    &.form-control {
+      box-shadow: none;
+    }
+  }
+}
+
+// Sidebar Search
+
+.td-sidebar__search {
+  margin-top: 15px;
+}
+
+#td-sidebar-menu {
+  .lang {
+
+    padding-top: 0.5rem;
+    padding-left: 1.5rem;
+  }
+}
+
+// Footer
+
+.releases .item {
+  background-color: #333;
+  color: #ffffff;
+  padding: 0 20px 20px;
+  z-index: 2;
+  float: left;
+  width: 100%;
+  margin-bottom: 30px;
+  position: relative;
+}
+
+.releases .item:after {
+  opacity: 0.05;
+  z-index: -1;
+  background-size: cover;
+  width: 100%;
+  height: 100%;
+  position: absolute;
+  top: 0;
+  left: 0;
+  content: '';
+}
+
+.releases .item .header {
+  color: #ffffff;
+  background: #428bca;
+  position: relative;
+  float: left;
+  margin-top: -8px;
+  padding: 5px 10px;
+  text-align: center;
+  font-size: 1.2em;
+}
+
+.releases .item .title {
+  clear: both;
+  color: #ffffff;
+  margin: 15px 0 55px;
+  float: left;
+  text-align: left;
+}
+
+.releases .item .title h3 {
+  font-size: 1.4em;
+  font-weight: 300;
+  line-height: inherit;
+}
+
+.releases .item .type {
+  float: left;
+  clear: both;
+}
+
+.td-footer {
+  background-color: #000;
+}
+
+// Reading Time
+
+.reading-time {
+  margin-top: 1.5em;
+}