Merge pull request #30 from markdumay/develop

Develop

.github/workflows/npm-publish.yml

@@ -0,0 +1,35 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  workflow_dispatch:
+    branches: [ main ]
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - run: npm ci
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

README.md

@@ -72,10 +72,7 @@ Start a new Hinode project in three steps:
 
 ### 1. Create a new site
 
-<!-- Hinode is available as a child theme, and a starter theme:
+Hinode is available as a [child theme][repository_child], and a [main theme][repository]. The child theme uses [npm][npm] to link to the latest available version of the Hinode theme. As such, it is less applicable if you plan to customize a lot. Vice versa, the main theme allows for heavy customization, but is not synchronized with the latest available Hinode theme automatically.
-
-- Use the Hinode child theme, if you do **not** plan to customize a lot, and/or need future Hinode updates.
-- Use the Hinode starter theme, if you plan to customize a lot, and/or do **not** need future Hinode updates.
 
 Not quite sure? Use the Hinode child theme.
 
@@ -85,7 +82,7 @@ Not quite sure? Use the Hinode child theme.
 git clone https://github.com/markdumay/hugo-theme-hinode-child.git my-hinode-site && cd my-hinode-site
 ```
 
-#### Hinode starter theme -->
+#### Hinode main theme
 
 ```bash
 git clone https://github.com/markdumay/hugo-theme-hinode.git my-hinode-site && cd my-hinode-site
@@ -107,11 +104,11 @@ npm run start
 
 The main site configuration is available in `./config/_default`. Some remarks:
 
-- Menu items - `menus/menus.en.toml` contains language-specific items for the navigation bar and social media links for the home page's footer.
+- **Menu items** - `menus/menus.en.toml` contains language-specific items for the navigation bar and social media links for the home page's footer.
-- Content - Ensure the `mainSections` in `config.toml` is synchronized with the `content` folder, default values are `["blog", "projects"]`.
+- **Content** - Ensure the `mainSections` in `config.toml` is synchronized with the `content` folder, default values are `["blog", "projects"]`.
-- Theme color - Update `themeColor` and `themeOpacity` within the `[style]` section of `params.toml` to update the site's primary color and opacity. You can use the [WCAG Color Contrast Checker][contrast_checker] to validate the contrast ratio of your color to improve accessibility.
+- **Theme color** - Update `themeColor` and `themeOpacity` within the `[style]` section of `params.toml` to update the site's primary color and opacity. You can use the [WCAG Color Contrast Checker][contrast_checker] to validate the contrast ratio of your color to improve accessibility.
-- Comments - Comments are powered by [utterances][utterances], a lightweight comments widget built on GitHub issues. Update the `repo`  of the `[comments]` section of `params.toml`.
+- **Comments** - Comments are powered by [utterances][utterances], a lightweight comments widget built on GitHub issues. Update the `repo`  of the `[comments]` section of `params.toml`.
-- Security headings - The local development server uses the header configuration as provided by `server.toml`. Similar settings are provided in the `netlify.toml` file provided in the repository's root when deploying to [Netlify][netlify].
+- **Security headings** - The local development server uses the header configuration as provided by `server.toml`. Similar settings are defined in the `netlify.toml` file provided in the repository's root when deploying to [Netlify][netlify].
 
 ## Contributing
 
@@ -137,7 +134,7 @@ The Hinode theme is inspired by the following themes:
 
 ## License
 
-The `hugo-theme-hinode` codebase is released under the [MIT license][license]. The documentation (including the "README") is licensed under the Creative Commons ([CC BY-NC 4.0)][cc-by-nc-4.0] license.
+The `hugo-theme-hinode` and `hugo-theme-hinode-child` codebase is released under the [MIT license][license]. The documentation (including the "README") is licensed under the Creative Commons ([CC BY-NC 4.0)][cc-by-nc-4.0] license.
 
 <!-- MARKDOWN PUBLIC LINKS -->
 [blist]: https://github.com/apvarun/blist-hugo-theme
@@ -163,3 +160,4 @@ The `hugo-theme-hinode` codebase is released under the [MIT license][license]. T
 [demo]: https://hinode-demo.markdumay.org/
 [license]: https://github.com/markdumay/hugo-theme-hinode/blob/main/LICENSE
 [repository]: https://github.com/markdumay/hugo-theme-hinode.git
+[repository_child]: https://github.com/markdumay/hugo-theme-hinode-child.git

layouts/_default/single.html

@@ -18,7 +18,7 @@
                     {{ else -}}
                          • 
                     {{ end -}}
-                    {{ i18n "readingTime"}}{{ .ReadingTime }} {{ i18n "minutesShort" }} {{ i18n "read" }}
+                    {{ .ReadingTime }} {{ i18n "minutesShort" }} {{ i18n "read" }}
                      •
                     {{ .WordCount }} {{ i18n "words" }}
                 </small>

layouts/partials/assets/blog-card.html

@@ -8,7 +8,7 @@
         <p class="card-text">
             <small class="text-muted text-uppercase">
                 {{- partial "utilities/date.html" (dict "date" .Date "language" $.Page.Language "format" "long") -}}
-                &bull; {{ i18n "readingTime"}}{{ .ReadingTime }}&nbsp;{{ i18n "minutesShort" }} {{ i18n "read" }}
+                &bull; {{ .ReadingTime }}&nbsp;{{ i18n "minutesShort" }} {{ i18n "read" }}
                 {{ if isset .Params "tags" -}}
                     {{ range first 1 .Params.tags -}}
                         &bull; <a href="{{ $.Site.BaseURL }}tags/{{ . | urlize }}" class="text-decoration-none text-primary" aria-label="Tag: {{ . }}">{{ . }}</a>

package-lock.json

@@ -1,11 +1,11 @@
 {
-  "name": "hugo-theme-hinode",
+  "name": "@markdumay/hugo-theme-hinode",
   "version": "0.1.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
-      "name": "hugo-theme-hinode",
+      "name": "@markdumay/hugo-theme-hinode",
       "version": "0.1.0",
       "hasInstallScript": true,
       "license": "MIT",

package.json

@@ -1,8 +1,12 @@
 {
-  "name": "hugo-theme-hinode",
+  "name": "@markdumay/hugo-theme-hinode",
   "version": "0.1.0",
   "description": "Hinode is a clean blog theme for Hugo, an open-source static site generator",
   "main": "index.js",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
   "scripts": {
     "init": "shx rm -rf .git && git init -b main",
     "create": "exec-bin node_modules/.bin/hugo/hugo new",
@@ -58,6 +62,6 @@
     "stylelint-config-standard-scss": "^3.0.0"
   },
   "otherDependencies": {
-    "hugo": "0.92.2"
+    "hugo": "0.96.0"
   }
 }