feat: Initial commit

main v0.1.0
earnest ma 1 year ago
commit 283423748c
Signed by: earnest ma
GPG Key ID: A343F43342EB6E2A
  1. 18
      .editorconfig
  2. 23
      CONTRIBUTING.md
  3. 20
      LICENSE
  4. 21
      README.md
  5. 493
      assets/css/main.css
  6. 6
      layouts/404.html
  7. 9
      layouts/_default/_markup/render-heading.html
  8. 12
      layouts/_default/baseof.html
  9. 34
      layouts/_default/list.html
  10. 13
      layouts/_default/single.html
  11. 3
      layouts/index.html
  12. 6
      layouts/partials/footer.html
  13. 1
      layouts/partials/head-custom.html
  14. 15
      layouts/partials/head.html
  15. 11
      layouts/partials/header.html
  16. 10
      theme.toml

@ -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

@ -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.

@ -0,0 +1,20 @@
Copyright (c) 2021 earnest ma <me@earne.link>
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.

@ -0,0 +1,21 @@
# nwt
A Hugo theme for your digital garden, notes, or wiki. Inspired by <http://wiki.xxiivv.com>, <https://rosano.hmm.garden/>, 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.

@ -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 <fieldset> 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;
}

@ -0,0 +1,6 @@
{{ define "title" }}404{{ end }}
{{ define "main" }}
<h1>404 - Page not found</h1>
<a href="/"><button class="top">Go Home</button></a>
{{ end }}

@ -0,0 +1,9 @@
<h{{ .Level }} id="{{ .Anchor | safeURL }}">
<a class="hash-link nohover" href="#{{ .Anchor | safeURL }}">
<svg width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="red" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
<title>Link to this section</title>
<path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path>
<path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path>
</svg>
</a>&nbsp;{{ .Text | safeHTML }}
</h{{ .Level }}>

@ -0,0 +1,12 @@
<!DOCTYPE html>
<html>
{{- partial "head.html" . }}
{{ partial "head-custom.html" . -}}
<body>
<header>{{ partial "header.html" . }}</header>
<div id="content">
{{- block "main" . }}{{- end }}
</div>
<footer>{{ partial "footer.html" . -}}</footer>
</body>
</html>

@ -0,0 +1,34 @@
{{ define "main" }}
<h2>{{ .Title }}</h2>
{{ if eq .Title "Wiki Index" }}
<ul>
{{ range .Pages }}
<li>
<a href="{{ .Permalink }}">{{ .Title }}</a>
</li>
{{ end }}
</ul>
{{ else }}
<h3>Subpages:</h3>
<ul>
<li><a href="..">Go back</a></li>
{{ range .Pages }}
<li>
<a href="{{ .Permalink }}">{{ .Title }}</a> <br>
</li>
{{ end }}
</ul>
{{ end }}
<hr>
{{ if $.Params.enabletoc }}
<div class="toc">
{{ .Page.TableOfContents }}
</div>
{{ end }}
{{ .Content }}
{{ end }}

@ -0,0 +1,13 @@
{{ define "main" }}
<h3>Subpages:</h3>
<ul>
{{ range .Pages }}
<li>
<a href="{{ .Permalink }}">{{ .Title }}</a> <br>
</li>
{{ end }}
</ul>
{{ .Content }}
{{ end }}

@ -0,0 +1,3 @@
{{ define "main" }}
{{ .Content }}
{{ end }}

@ -0,0 +1,6 @@
<p>{{ .Site.Copyright }}</p>
<nav>
{{ range .Site.Menus.main }}
<a href="{{ .URL }}">{{ .Name }}</a>
{{ end }}
</nav>

@ -0,0 +1 @@
<!--Create your own copy of "layouts/partials/head-custom.html" to add additional -->

@ -0,0 +1,15 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<title>{{ if .IsHome }}{{ $.Site.Title }}{{ else }}{{ .Title }} ─ {{ $.Site.Title }}{{ end }}</title>
{{ with .Site.Params.favicon }}<link rel="shortcut icon" href="{{ . | absURL }}" />{{ end }}
<meta name="title" content="{{ with .Title }}{{ . }}{{ else }}{{ .Site.Title }}{{ end }}" />
<meta name="description" content="{{ with .Description }}{{ . }}{{ else }}{{if .IsPage }}{{ .Summary }}{{ else }}{{ with .Site.Params.description }}{{ . }}{{ end }}{{ end }}{{ end }}" />
<meta name="keywords" content="{{ if .IsPage}}{{ range $index, $tag := .Params.tags }}{{ $tag }},{{ end }}{{ else }}{{ range $plural, $terms := .Site.Taxonomies }}{{ range $term, $val := $terms }}{{ printf "%s," $term }}{{ end }}{{ end }}{{ end }}" />
{{ if $.Params.noindex }}<meta name="robots" content="noindex">{{ end }}
<meta name="author" content="{{ range .Site.Author }}{{ . }}{{ end }}">
<meta name="referrer" content="no-referrer-when-downgrade" />
{{- $style := resources.Get "/css/main.css" | toCSS | minify | fingerprint }}
<link rel="stylesheet" href="{{ $style.Permalink }}">
{{ template "_internal/opengraph.html" . }}
{{ template "_internal/schema.html" . }}
{{ template "_internal/twitter_cards.html" . }}

@ -0,0 +1,11 @@
<a href="{{ " /" | relURL }}">
<h2>{{ .Site.Title }}</h2>
</a>
<nav>
{{ range .Site.Menus.main }}
<b><a href="{{ .URL }}">{{ .Name }}</a></b>
{{ end }}
{{ range .Site.Menus.pinned }}
<a href="{{ .URL }}">{{ .Name }}</a>
{{ end }}
</nav>

@ -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"