traceypooh / blogtini

Markdown + JS 100% client-side blogs & websites
8 stars 3 forks source link
blog-theme esmodules github-pages highlightjs html javascript lunrjs markdown showdownjs static-site

blogtini

Slides / presentation

https://traceypooh.github.io/slides/dweb-2022 (tracey talk at https://dwebcamp.org)

Site live at:

Hooks

Thus, we suggest you use our "pre commit" and "post merge" git 'hooks' to automate the above "housekeeping". You can set them up like this:

git config --local core.hooksPath bin/

RSS

If you'd like a RSS index.xml file generated with the bin/sitemap script, during each "pre commit" hook (above), you'll need to have the yq script installed on your machine.

Best two website/blog setup options

Blog source repository that uses markdown inside html markup files

Blog source repository that uses markdown files

Local development

Option 1

safari is nice, you can run the site locally by just

Option 2

(any basic static file webserver will do):

( sleep 3; open http://localhost:8000 ) &
python3 -m http.server

You can force a re-parse of posts & pages by adding optional CGI arg ?recache=1

Example urls using GitHub or GitLab pages

If you use https://github.com or https://gitlab.com free 'Pages' integration, you will get urls you can like this:

You can choose to use your own domain name (typically ~$20 USD/year) for a shorter/nicer url that points to the Pages deployment above (this is what https://blogtini.com does)

To Do / Fixmes