thurstylark
/
tlwiki
1
0
Fork 0
Code Issues 6 Pull Requests Projects Releases Wiki Activity
Source for Thurstylark's Wiki https://wiki.thurstylark.com/
145 Commits 1 Branch 0 Tags 2.5 MiB
Python 93.6%
Elixir 6.4%
Go to file
David Thurstenson ffaaf73e67 about/contact: Updated discord username 2023-06-27 14:56:07 -05:00
content about/contact: Updated discord username 2023-06-27 14:56:07 -05:00
static/images Updating logo submodule 2021-10-07 02:26:22 -05:00
themes Update theme with new aside layout 2022-01-05 17:28:22 -06:00
.gitignore Added README 2021-11-21 16:47:03 -06:00
.gitmodules Fixing git submodule mess 2021-11-21 14:06:52 -06:00
README.md README: fix ln command (swapped arguments) 2022-01-05 12:12:06 -06:00
config.toml config: Enable git info access 2022-01-05 12:37:02 -06:00
tlwiki Run tlwiki script with a default set of options when run as a git pre-push hook 2021-10-07 07:40:50 -05:00
tlwiki-conf.yaml.ex Added example tlwiki-conf.yaml 2021-10-07 07:46:56 -05:00

README.md

Thurstylark's wiki

Requirements

  • Base
    • hugo
  • Optional (only required for tlwiki management script)
    • git
    • python3
    • rsync

Usage

Environment Setup

Using tlwiki script

  1. Create tlwiki-conf.yaml using tlwiki-conf.yaml.ex as a template
  2. Run ./tlwiki updeps to pull in the latest version of all git submodules

Using individual commands

  1. Initialize all git submodules
git submodule update --init --recursive

Deploy

Using tlwiki script

  1. Ensure the values for deployID.user, deployID.host, and deployID.dir are correct
    • For best results, use rsync with a non-interactive authentication method such as ssh key pairs
  2. Run ./tlwiki deploy

Using individual commands

  1. Run hugo to build the site
  2. 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