From 283423748c714bbbe347364a808fa900278e9521 Mon Sep 17 00:00:00 2001 From: earnest ma Date: Mon, 29 Nov 2021 21:30:06 -0500 Subject: [PATCH] feat: Initial commit --- .editorconfig | 18 + CONTRIBUTING.md | 23 + LICENSE | 20 + README.md | 21 + assets/css/main.css | 493 +++++++++++++++++++ layouts/404.html | 6 + layouts/_default/_markup/render-heading.html | 9 + layouts/_default/baseof.html | 12 + layouts/_default/list.html | 34 ++ layouts/_default/single.html | 13 + layouts/index.html | 3 + layouts/partials/footer.html | 6 + layouts/partials/head-custom.html | 1 + layouts/partials/head.html | 15 + layouts/partials/header.html | 11 + theme.toml | 10 + 16 files changed, 695 insertions(+) create mode 100644 .editorconfig create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 assets/css/main.css create mode 100644 layouts/404.html create mode 100644 layouts/_default/_markup/render-heading.html create mode 100644 layouts/_default/baseof.html create mode 100644 layouts/_default/list.html create mode 100644 layouts/_default/single.html create mode 100644 layouts/index.html create mode 100644 layouts/partials/footer.html create mode 100644 layouts/partials/head-custom.html create mode 100644 layouts/partials/head.html create mode 100644 layouts/partials/header.html create mode 100644 theme.toml diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..3fef523 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,18 @@ +# EditorConfig is awesome: https://EditorConfig.org + +# top-most EditorConfig file +root = true + +[*] +indent_style = space +indent_size = 2 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.html] +insert_final_newline = false + +[Makefile] +indent_style = tab diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0db04d0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# Contributing + +Subscribe to [this mailing list](https://lists.sr.ht/~earnestma/nwt-announce/) for announcements and new release notes. + +## Support + +- Matrix space: [#earne:envs.net](https://matrix.to/#/#earne:envs.net) +- Mailing list: https://lists.sr.ht/~earnestma/nwt-devel + +## Issues + +Discuss on the above spaces and open a [ticket here](https://todo.sr.ht/~earnestma/nwt). + +## Patches + +Patches for docs only should be done against [nwt-docs](https://git.sr.ht/~earnestma/nwt-docs). Otherwise, if you adding a new feature or documentation, modify `docs/` in the main repo at the same time. + +If you need more help sending patches, you may take a look at [this guide](https://git-send-email.io/). + +- Clone the repository and move into that directory +- Set `git config format.subjectPrefix "PATCH repo-name"` correctly +- Make your change(s), test if needed, and commit it +- Use `git send-email` to send it to `~earnestma/nwt-devel@lists.sr.ht`! Feel free to send multiple commits in order and with a cover letter if needed. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..394446c --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +Copyright (c) 2021 earnest ma + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: + +Be Gay, Do Crimes +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..95fb307 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# nwt + +A Hugo theme for your digital garden, notes, or wiki. Inspired by , , and *many* others. Subscribe to [this mailing list](https://lists.sr.ht/~earnestma/nwt-announce/) for announcements and new release notes. + +## Use + +### Prerequisites + +- [Hugo extended v0.80.0 or greater](https://gohugo.io) + +### Installing and usage + +See `docs/` directory or the [online manual](https://man.sr.ht/~earnestma/nwt). The online manual sources are available as Markdown in [this git repository](https://git.sr.ht/~earnestma/nwt-docs). + +## Contributing + +Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting patches to us. + +## License + +See the [LICENSE](LICENSE) for details. It also contains a list of maintainers and contributors. diff --git a/assets/css/main.css b/assets/css/main.css new file mode 100644 index 0000000..7552cf3 --- /dev/null +++ b/assets/css/main.css @@ -0,0 +1,493 @@ +/* Set the global variables for everything. Change these to use your own fonts and colours. */ +:root { + + /* Set sans-serif & mono fonts */ + /* --sans-font: -apple-system, BlinkMacSystemFont, "Avenir Next", Avenir, "Nimbus Sans L", Roboto, Noto, "Segoe UI", Arial, Helvetica, "Helvetica Neue", sans-serif; + --mono-font: Consolas, Menlo, Monaco, "Andale Mono", "Ubuntu Mono", monospace; */ + + /* Body font size. By default, effectively 18.4px, based on 16px as 'root em' */ + --base-fontsize: 1.15rem; + + /* Major third scale progression - see https://type-scale.com/ */ + --header-scale: 1.25; + + /* Line height is set to the "Golden ratio" for optimal legibility */ + --line-height: 1.618; + + /* Default (light) theme */ + --bg: #FFF; + --accent-bg: #F5F7FF; + --text: #212121; + --text-light: #585858; + --border: #D8DAE1; + --accent: #0D47A1; + --accent-light: #90CAF9; + --code: #D81B60; + --preformatted: #444; + --marked: #FFDD33; + --disabled: #EFEFEF; +} + +/* Dark theme */ +@media (prefers-color-scheme: dark) { + :root { + --bg: #212121; + --accent-bg: #2B2B2B; + --text: #DCDCDC; + --text-light: #ABABAB; + --border: #666; + --accent: #FFB300; + --accent-light: #FFECB3; + --code: #F06292; + --preformatted: #CCC; + --disabled: #111; + } + + img, video { + opacity: .6; + } +} + +html { + /* Set the font globally */ + /* font-family: var(--sans-font); */ +} + +/* Make the body a nice central block */ +body { + color: var(--text); + background: var(--bg); + font-size: var(--base-fontsize); + line-height: var(--line-height); + display: flex; + min-height: 100vh; + flex-direction: column; + flex: 1; + margin: 0 auto; + max-width: 45rem; + padding: 0 .5rem; + overflow-x: hidden; + word-break: break-word; + overflow-wrap: break-word; +} + +/* Make the header bg full width, but the content inline with body */ +header { + background: var(--accent-bg); + border-bottom: 1px solid var(--border); + text-align: center; + padding: 2rem .5rem; + width: 100vw; + position: relative; + box-sizing: border-box; + left: 50%; + right: 50%; + margin-left: -50vw; + margin-right: -50vw; +} + + +/* Remove margins for header text */ +header h1, +header p { + margin: 0; +} + +/* Fix line height when title wraps */ +h1, h2, h3 { + line-height: 1.1; +} + +/* Format navigation */ +nav { + font-size: 1rem; + line-height: 2; + padding: 1rem 0; +} + +nav a { + margin: 1rem 1rem 0 0; + border: 1px solid var(--border); + border-radius: 5px; + color: var(--text) !important; + display: inline-block; + padding: .1rem 1rem; + text-decoration: none; + transition: .4s; +} + +nav a:hover { + color: var(--accent) !important; + border-color: var(--accent); +} + +nav a.current:hover { + text-decoration: none; +} + +footer { + margin-top: 4rem; + padding: 2rem 1rem 1.5rem 1rem; + color: var(--text-light); + font-size: .9rem; + text-align: center; + border-top: 1px solid var(--border); +} + +/* Format headers */ +h1 { + font-size: calc(var(--base-fontsize) * var(--header-scale) * var(--header-scale) * var(--header-scale) * var(--header-scale)); + margin-top: calc(var(--line-height) * 1.5rem); +} + +h2 { + font-size: calc(var(--base-fontsize) * var(--header-scale) * var(--header-scale) * var(--header-scale)); + margin-top: calc(var(--line-height) * 1.5rem); +} + +h3 { + font-size: calc(var(--base-fontsize) * var(--header-scale) * var(--header-scale)); + margin-top: calc(var(--line-height) * 1.5rem); +} + +h4 { + font-size: calc(var(--base-fontsize) * var(--header-scale)); + margin-top: calc(var(--line-height) * 1.5rem); +} + +h5 { + font-size: var(--base-fontsize); + margin-top: calc(var(--line-height) * 1.5rem); +} + +h6 { + font-size: calc(var(--base-fontsize) / var(--header-scale)); + margin-top: calc(var(--line-height) * 1.5rem); +} + +/* Format links & buttons */ +a, +a:visited { + color: var(--accent); +} + +a:hover { + text-decoration: none; +} + +a button, +button, +input[type="submit"], +input[type="reset"], +input[type="button"] { + border: none; + border-radius: 5px; + background: var(--accent); + font-size: 1rem; + color: var(--bg); + padding: .7rem .9rem; + margin: .5rem 0; + transition: .4s; +} + +a button[disabled], +button[disabled], +input[type="submit"][disabled], +input[type="reset"][disabled], +input[type="button"][disabled], +input[type="checkbox"][disabled], +input[type="radio"][disabled], +select[disabled] { + cursor: default; + opacity: .5; + cursor: not-allowed; +} + +input:disabled, +textarea:disabled, +select:disabled { + cursor: not-allowed; + background-color: var(--disabled); +} + +input[type="range"] { + padding: 0; +} + +/* Set the cursor to '?' while hovering over an abbreviation */ +abbr { + cursor: help; +} + +button:focus, +button:enabled:hover, +input[type="submit"]:focus, +input[type="submit"]:enabled:hover, +input[type="reset"]:focus, +input[type="reset"]:enabled:hover, +input[type="button"]:focus, +input[type="button"]:enabled:hover, +input[type="checkbox"]:focus, +input[type="checkbox"]:enabled:hover, +input[type="radio"]:focus, +input[type="radio"]:enabled:hover{ + opacity: .8; + cursor: pointer; +} + +/* Format the expanding box */ +details { + background: var(--accent-bg); + border: 1px solid var(--border); + border-radius: 5px; + margin-bottom: 1rem; +} + +summary { + cursor: pointer; + font-weight: bold; + padding: .6rem 1rem; +} + +details[open] { + padding: .6rem 1rem .75rem 1rem; +} + +details[open] summary { + margin-bottom: .5rem; + padding: 0; +} + +details[open]>*:last-child { + margin-bottom: 0; +} + +/* Format tables */ +table { + border-collapse: collapse; + width: 100%; + margin: 1.5rem 0; +} + +td, +th { + border: 1px solid var(--border); + text-align: left; + padding: .5rem; +} + +th { + background: var(--accent-bg); + font-weight: bold; +} + +tr:nth-child(even) { + /* Set every other cell slightly darker. Improves readability. */ + background: var(--accent-bg); +} + +table caption { + font-weight: bold; + margin-bottom: .5rem; +} + +/* Lists */ +ol, +ul { + padding-left: 3rem; +} + +/* Format forms */ +textarea, +select, +input { + font-size: inherit; + font-family: inherit; + padding: .5rem; + margin-bottom: .5rem; + color: var(--text); + background: var(--bg); + border: 1px solid var(--border); + border-radius: 5px; + box-shadow: none; + box-sizing: border-box; + width: 60%; + -moz-appearance: none; + -webkit-appearance: none; + appearance: none; +} + +/* Add arrow to select */ +select { + background-image: + linear-gradient(45deg, transparent 49%, var(--text) 51%), + linear-gradient(135deg, var(--text) 51%, transparent 49%); + background-position: + calc(100% - 20px), + calc(100% - 15px); + background-size: + 5px 5px, + 5px 5px; + background-repeat: no-repeat; +} + +/* checkbox and radio button style */ +input[type="checkbox"], input[type="radio"]{ + vertical-align: bottom; + position: relative; +} +input[type="radio"]{ + border-radius: 100%; +} + +input[type="checkbox"]:checked, +input[type="radio"]:checked { + background: var(--accent); +} + +input[type="checkbox"]:checked::after { + /* Creates a rectangle with colored right and bottom borders which is rotated to look like a check mark */ + content: ' '; + width: 0.1em; + height: 0.25em; + border-radius: 0; + position: absolute; + top: 0.05em; + left: 0.18em; + background: transparent; + border-right: solid var(--bg) 0.08em; + border-bottom: solid var(--bg) 0.08em; + font-size: 1.8em; + transform: rotate(45deg); +} +input[type="radio"]:checked::after { + /* creates a colored circle for the checked radio button */ + content: ' '; + width: .25em; + height: .25em; + border-radius: 100%; + position: absolute; + top: 0.125em; + background: var(--bg); + left: 0.125em; + font-size: 32px; +} + +/* Make the textarea wider than other inputs */ +textarea { + width: 80% +} + +/* Makes input fields wider on smaller screens */ +@media only screen and (max-width: 720px) { + textarea, + select, + input { + width: 100%; + } +} + +/* Ensures the checkbox and radio inputs do not have a set width like other input fields */ +input[type="checkbox"], input[type="radio"]{ + width: auto; +} + +/* do not show border around file selector button */ +input[type="file"] { + border: 0; +} + +/* Without this any HTML using
shows ugly borders and has additional padding/margin. (Issue #3) */ +fieldset { + border: 0; + padding: 0; + margin: 0; +} + +/* Misc body elements */ + +hr { + color: var(--border); + border-top: 1px; + margin: 1rem auto; +} + +mark { + padding: 2px 5px; + border-radius: 4px; + background: var(--marked); +} + +main img, main video { + max-width: 100%; + height: auto; + border-radius: 5px; +} + +figure { + margin: 0; +} + +figcaption { + font-size: .9rem; + color: var(--text-light); + text-align: center; + margin-bottom: 1rem; +} + +blockquote { + margin: 2rem 0 2rem 2rem; + padding: .4rem .8rem; + border-left: .35rem solid var(--accent); + opacity: .8; + font-style: italic; +} + +cite { + font-size: 0.9rem; + color: var(--text-light); + font-style: normal; +} + +/* Use mono font for code like elements */ +code, +pre, +pre span, +kbd, +samp { + font-size: 1.075rem; + /* font-family: var(--mono-font); */ + color: var(--code); +} + +kbd { + color: var(--preformatted); + border: 1px solid var(--preformatted); + border-bottom: 3px solid var(--preformatted); + border-radius: 5px; + padding: .1rem; +} + +pre { + padding: 1rem 1.4rem; + max-width: 100%; + overflow: auto; + overflow-x: auto; + color: var(--preformatted); + background: var(--accent-bg); + border: 1px solid var(--border); + border-radius: 5px; +} + +/* Fix embedded code within pre */ +pre code { + color: var(--preformatted); + background: none; + margin: 0; + padding: 0; +} + +.hash-link { + text-decoration: none; + padding: 1 5px; +} diff --git a/layouts/404.html b/layouts/404.html new file mode 100644 index 0000000..a454461 --- /dev/null +++ b/layouts/404.html @@ -0,0 +1,6 @@ +{{ define "title" }}404{{ end }} + +{{ define "main" }} +

404 - Page not found

+ +{{ end }} \ No newline at end of file diff --git a/layouts/_default/_markup/render-heading.html b/layouts/_default/_markup/render-heading.html new file mode 100644 index 0000000..506292f --- /dev/null +++ b/layouts/_default/_markup/render-heading.html @@ -0,0 +1,9 @@ + + + + Link to this section + + + +  {{ .Text | safeHTML }} + \ No newline at end of file diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html new file mode 100644 index 0000000..7f33e52 --- /dev/null +++ b/layouts/_default/baseof.html @@ -0,0 +1,12 @@ + + + {{- partial "head.html" . }} + {{ partial "head-custom.html" . -}} + +
{{ partial "header.html" . }}
+
+ {{- block "main" . }}{{- end }} +
+
{{ partial "footer.html" . -}}
+ + diff --git a/layouts/_default/list.html b/layouts/_default/list.html new file mode 100644 index 0000000..2c7d201 --- /dev/null +++ b/layouts/_default/list.html @@ -0,0 +1,34 @@ +{{ define "main" }} +

{{ .Title }}

+ +{{ if eq .Title "Wiki Index" }} + +{{ else }} +

Subpages:

+ +{{ end }} + +
+ +{{ if $.Params.enabletoc }} +
+ {{ .Page.TableOfContents }} +
+{{ end }} + +{{ .Content }} + +{{ end }} diff --git a/layouts/_default/single.html b/layouts/_default/single.html new file mode 100644 index 0000000..a06cade --- /dev/null +++ b/layouts/_default/single.html @@ -0,0 +1,13 @@ +{{ define "main" }} + +

Subpages:

+ + +{{ .Content }} +{{ end }} \ No newline at end of file diff --git a/layouts/index.html b/layouts/index.html new file mode 100644 index 0000000..cdb4a08 --- /dev/null +++ b/layouts/index.html @@ -0,0 +1,3 @@ +{{ define "main" }} + {{ .Content }} +{{ end }} \ No newline at end of file diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html new file mode 100644 index 0000000..2fbe09f --- /dev/null +++ b/layouts/partials/footer.html @@ -0,0 +1,6 @@ +

{{ .Site.Copyright }}

+ \ No newline at end of file diff --git a/layouts/partials/head-custom.html b/layouts/partials/head-custom.html new file mode 100644 index 0000000..e40a153 --- /dev/null +++ b/layouts/partials/head-custom.html @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/layouts/partials/head.html b/layouts/partials/head.html new file mode 100644 index 0000000..4a36a7e --- /dev/null +++ b/layouts/partials/head.html @@ -0,0 +1,15 @@ + + +{{ if .IsHome }}{{ $.Site.Title }}{{ else }}{{ .Title }} ─ {{ $.Site.Title }}{{ end }} +{{ with .Site.Params.favicon }}{{ end }} + + + +{{ if $.Params.noindex }}{{ end }} + + +{{- $style := resources.Get "/css/main.css" | toCSS | minify | fingerprint }} + +{{ template "_internal/opengraph.html" . }} +{{ template "_internal/schema.html" . }} +{{ template "_internal/twitter_cards.html" . }} \ No newline at end of file diff --git a/layouts/partials/header.html b/layouts/partials/header.html new file mode 100644 index 0000000..7e2dc76 --- /dev/null +++ b/layouts/partials/header.html @@ -0,0 +1,11 @@ + +

{{ .Site.Title }}

+ + \ No newline at end of file diff --git a/theme.toml b/theme.toml new file mode 100644 index 0000000..f334b2e --- /dev/null +++ b/theme.toml @@ -0,0 +1,10 @@ +name = "nwt" +license = "MIT" +licenselink = "https://git.sr.ht/~earnestma/nwt/tree/main/item/LICENSE" +description = "Personal digital garden, notes, or wiki theme for Hugo" +homepage = "https://sr.ht/~earnestma/nwt" +min_version = "0.80.0" + +[author] + name = "Earnest Ma" + homepage = "https://earnestma.xyz"