commit 62146e84cddef04b4d6e800c3590ffdb85159c96 Author: earnest ma Date: Mon Nov 29 22:59:03 2021 -0500 Initial commit diff --git a/configuration.md b/configuration.md new file mode 100644 index 0000000..460f763 --- /dev/null +++ b/configuration.md @@ -0,0 +1,3 @@ +--- +title: Configuration +--- diff --git a/index.md b/index.md new file mode 100644 index 0000000..8f18050 --- /dev/null +++ b/index.md @@ -0,0 +1,6 @@ +# nwt docs + +A Hugo theme for your digital garden, notes, or wiki. + +- [Installation](install.md) +- [Configuration](configuration.md) diff --git a/install.md b/install.md new file mode 100644 index 0000000..994c346 --- /dev/null +++ b/install.md @@ -0,0 +1,44 @@ +--- +title: Installation +--- + +## Hugo module + +`hugo mod init ${url}/ module name` + +config.toml: + +```toml +[module] +[[module.imports]] + path = 'git.sr.ht/~earnestma/nwt' +``` + +`hugo mod get git.sr.ht/~earnestma/nwt@{version}` + +## Use a tarball + +Grab a tagged version through `https://git.sr.ht/~earnestma/nwt/archive/${version}.tar.gz` and extract it: `themes/nwt`. + +## Git subtree + +```bash +# Add the remote +git remote add -f nwt https://git.sr.ht/~earnestma/nwt + +# Add the subtree +git subtree add --prefix themes/nwt nwt ${version} --squash + +# Updates +git subtree pull --prefix themes/nwt nwt ${version} --squash +``` + +## Git submodule + +```bash +git submodule add https://git.sr.ht/~earnestma/nwt themes/nwt +cd themes/nwt + +# checkout the latest tag +git checkout $(git tag --contains | tail -1) +```