tech design decisions

asciidoctor

Switched to using asciidoctor over markdown. Looks much better. Wasted time confusing asciidoc and asciidoctor thinking they were the same thing. God damn open source names.

jekyll

Disregarded jekyll completely. I render the asciidoc to html myself and serve it via docs. Why? configuring github pages to match my local jekyll instances looks like its own hell.

final design

  1. directories

    1. original contains all posts. they are numbered and controlled via map.php for easier manipulation + reorganization

    2. blog contains all posts renamed for url friendlyness. titles are dynamic. do not edit. generated from original/scripts/build-index.php

    3. docs contains all html stuff transformed blog. designed for github pages so it simply renders them as is and doesn’t do anything extra

  2. files

    1. original/map.php site map — used as the index. controls blog/[filenames]

    2. original/scripts/build-index.php watch files and render blog + create html files in docs/

    3. original/index-tmpl.adoc template files used to generate blog/index.adoc

usage

# watch files and render blog + create html files in docs/
cd original
wf scripts/build-index.php

# auto-create files, rename and organize
map.php

# wip/wgp
commit changes and push

# hide changes in docs
git-assume-status docs/*.html

improvements

  1. use jekyll at least locally to benefit from things such as layout and such. for now, layout is injected via header in original/scripts/build-index.php