dfd-archives/wild-theme-shell-mod-hugo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
The Hugo wrapper (shell) module for themes by Wild Tech 'Garden' (WTG) -- very pre-alpha. https://www.wild-theme-shell.wtg-demos.ca/
138 commits 2 branches 15 tags 420 KiB
  • HTML 43.3%
  • CSS 41.8%
  • Shell 13.7%
  • PowerShell 1.2%
Find a file
Exact
Daniel F. Dickinson 0f4b8f5146
 Update wild-theme-shell and fix config name 
We need to avoid root's go.mod and go.sum being modified except for
the actual dependency on wild-theme-shell. We therefore rename
tests/config/hugo.toml as tests/config/test-config.toml, which Hugo does
not automatically use, and update our scripts to point to this config
for testing builds and the demo site.

Signed-off-by: Daniel F. Dickinson <dfdpublic@wildtechgarden.ca>
2023-10-29 19:03:13 -04:00
.github/workflows Update wild-theme-shell and fix config name 2023-10-29 19:03:13 -04:00
.vscode Fix default md to use tabs and user's width 2023-10-22 23:56:13 -04:00
archetypes Add archetypes & some basic CSS (tweaking baseof) 2023-08-27 08:33:39 -04:00
assets/wtg-shell/css Move additional language selector styles out 2023-10-29 00:31:15 -04:00
content Update demo site and improve docs layout 2023-09-12 00:40:36 -04:00
docs Start adding documentation for the theme shell 2023-08-31 02:34:08 -04:00
i18n Remove some i18n strings moved to a-wild-theme 2023-10-29 18:52:31 -04:00
layouts Remove language selector from nav header layout 2023-10-29 01:32:45 -04:00
scripts Update wild-theme-shell and fix config name 2023-10-29 19:03:13 -04:00
tests Update wild-theme-shell and fix config name 2023-10-29 19:03:13 -04:00
.editorconfig Fix default md to use tabs and user's width 2023-10-22 23:56:13 -04:00
.gitignore Ignore any resources (including under tests) dir 2023-08-27 07:17:00 -04:00
.markdownlint.json Set markdownlint to allow URLs past 80 characters 2023-08-30 10:24:49 -04:00
.pre-commit-config.yaml Update pre-commit hooks 2023-09-26 22:31:55 -04:00
.stylelintrc.json Enforce basic alphabetical order for CSS 2023-08-29 18:24:33 -04:00
.yamllint.yaml Initial commit 2023-08-24 03:53:08 -04:00
cspell.json Update wild-theme-shell and fix config name 2023-10-29 19:03:13 -04:00
go.mod Remove Hugo modules from wrong directory 2023-09-26 22:33:00 -04:00
go.sum Remove Hugo modules from wrong directory 2023-09-26 22:33:00 -04:00
hugo.toml Move our demo-test-site-content here & update conf 2023-09-03 15:21:02 -04:00
LICENSE Initial commit 2023-08-24 03:53:08 -04:00
package-lock.json Update NPM dependencies 2023-09-02 15:06:58 -04:00
package.json Tweak colour schemes for better look / contrast 2023-09-04 10:44:36 -04:00
README.fr.md Add build-audit action CI badge and fix workflow 2023-09-09 22:59:30 -04:00
README.md Add build-audit action CI badge and fix workflow 2023-09-09 22:59:30 -04:00
SCRATCHPAD-WISHLIST.md Update wishlist/spec document 2023-10-29 01:34:20 -04:00
SCRATCHPAD.md Fix wrong subdir for theme partial in docs 2023-10-22 23:56:49 -04:00
theme.toml Add a basic theme.toml (mostly placeholders) 2023-09-04 10:41:19 -04:00
wild-theme-shell-mod-hugo.code-workspace Add module starter to workspace 2023-09-03 15:19:49 -04:00
words-fr-project.txt Start adding documentation for the theme shell 2023-08-31 02:34:08 -04:00
words-project.txt Add more updates to wishlist 2023-10-25 02:36:45 -04:00

README.md

'Wild' theme shell for Hugo by Wild Tech 'Garden'

Description: The Hugo shell (wrapper) module for themes by Wild Tech 'Garden' (WTG)
Site: https://www.wild-theme-shell.wtg-demos.ca/
Repository: https://github.com/wildtechgarden/wild-theme-shell-mod-hugo
CI Status: pre-commit.ci status build-audit

Contents

  1. Contents
  2. Features
    1. Designed for extensibility
    2. Minimal theme in its own right
    3. Classless or classful CSS supported
    4. Comes with sample 'responsive' vanilla CSS
  3. Usage
    1. Basic (as theme)
      1. Hugo module (preferred)
      2. With git submodule (unsupported by theme author)
    2. Configuration
    3. Extension (the hooks)
      1. The base (skeleton)
  4. Development
  5. Colophon

Features

Designed for extensibility

Primarily designed as a skeleton with 'hooks' to be supplied by the consumer of this shell (e.g. can be site-specific or used by a theme that extends the shell).

See Extension (the hooks), below.

Minimal theme in its own right

The skeleton has defaults for the 'hooks' that are sufficient to allow you to use this project as a minimal theme for websites.

See Usage, below.

Classless or classful CSS supported

The HTML in the skeleton defaults to no classes on the elements by default, but accepts parameters to override this behaviour (often can be site-wide or per-page, or site-wide with page overrides, as you choose).

Comes with sample 'responsive' vanilla CSS

  1. Defaults to mobile menu as header until on larger screens
  2. Includes a selection of starter colour schemes
  3. Includes styles for reasonable printed output

Usage

Basic (as theme)

Hugo module (preferred)

  1. Initialize the Hugo module system: hugo mod init github.com/<your_user>/<your_project>; (assuming you are using GitHub, of course).

  2. Import the theme in your hugo.toml

    [module]
[[module.imports]]
path = "github.com/wildtechgarden/wild-theme-shell-mod-hugo"

  3. Get the module

    hugo mod get github.com/wildtechgarden/wild-theme-shell-mod-hugo

  4. To test the result, run the local Hugo server

    hugo server -b http://localhost:1313/

With git submodule (unsupported by theme author)

  1. Make a themes directory and switch to it.

    mkdir themes
cd themes

  2. In the themes directory, add wild-theme-shell-mod-hugo as a submodule

    git submodule add -f https://github.com/wildtechgarden/wild-theme-shell-mod-hugo.git

  3. Change back to the site directory

  4. To test the result, run the local Hugo server

    hugo server -t wild-theme-shell-mod-hugo -b http://localhost:1313/

Enjoy!

Configuration

Extension (the hooks)

The base (skeleton)

See skeleton documentation

Development

Colophon

Copyright © 2023 Wild Tech 'Garden'
Released under an MIT License