Source for Thurstylark's Wiki
https://wiki.thurstylark.com/
David Thurstenson b678c44499 | ||
---|---|---|
content | ||
static/images | ||
themes | ||
.gitignore | ||
.gitmodules | ||
README.md | ||
config.toml | ||
tlwiki | ||
tlwiki-conf.yaml.ex |
README.md
Thurstylark's wiki
Requirements
- Base
- hugo
- Optional (only required for
tlwiki
management script)- git
- python3
- rsync
Usage
Environment Setup
Using tlwiki
script
- Create
tlwiki-conf.yaml
usingtlwiki-conf.yaml.ex
as a template - Run
./tlwiki updeps
to pull in the latest version of all git submodules
Using individual commands
- Initialize all git submodules
git submodule update --init --recursive
Deploy
Using tlwiki
script
- Ensure the values for
deployID.user
,deployID.host
, anddeployID.dir
are correct- For best results, use rsync with a non-interactive authentication method such as ssh key pairs
- Run
./tlwiki deploy
Using individual commands
- Run
hugo
to build the site - Copy the contents of
public/
to your web server's document root
Hacking
Automatically run ./tlwiki deploy
on git push
Create a symlink named .git/hooks/pre-push
with tlwiki
as its target:
ln -s ../../tlwiki .git/hooks/pre-push
tlwiki
will help manage this symlink in the future (See: #1)
Serve the site locally for testing
hugo server
More info: https://gohugo.io/commands/hugo_server/
tlwiki-config.yaml
Configuration Options
Path | Type | Default | Description |
---|---|---|---|
deployID.user | string | rsync username (USER in USER@HOST:DIR ) |
|
deployID.host | string | rsync hostname (HOST in USER@HOST:DIR ) |
|
deployID.dir | string | rsync target remote directory (DIR in USER@HOST:DIR ) |
|
repo.URL | string | Unused | |
repo.branch | string | Unused | |
repo.remoteName | string | Unused |