README (1399B)
1 shite 2 ======= 3 site generator tools in /bin/sh. 4 5 Dependencies 6 -------------- 7 shite depends on the lowdown[^0] Markdown 'translator' to convert Markdown 8 into HTML. If your OS is POSIX-compliant out of the box, this is the only 9 program you will need to install. 10 11 * lowdown 12 * find 13 * a POSIX-compliant /bin/sh 14 15 About 16 ------- 17 shite is the successor to the shlog[^1] project, separating each of its 18 main functions into serveral scripts: 19 20 * rss.sh - generates rss feed of posts 21 * index.sh - generates a html page listing posts in chronological order 22 * shite - finds and converts html -> markdown 23 24 All scripts source a .env file in the current directory. For an template see 25 .env.template. It is assumed all scripts are run at the root of the static 26 site's heirachy. 27 28 These scripts have been tested on the latest OpenBSD-current and the latest 29 Ubuntu on WSL2. 30 31 Usage 32 ------- 33 34 1. Copy .env.template to the root of your static site as ./.env 35 2. Edit .env to your specifications 36 3. Populate $html_dir with: 37 - footer.html - footer content 38 - head.html - <head> content 39 - header.html - header/nav content 40 - index_head.html - post index prefix 41 This is placed before posts are listed 42 - index_tail.html - post index postfix 43 This is placed after posts are listed 44 45 ---- 46 47 [^0]: https://kristaps.bsd.lv/lowdown/ 48 [^1]: https://github.com/e-zk/shlog 49