web

Notes regarding simple web-publishing workflow and tools.

aim

To be able to quickly capture notes as text and to then be able to publish them in a coherent fashion.

constraints

1. Workflow must minimise the effort required to capture notes and the overhead to publish them.
2. All data must be in as close as practical to raw text to maximise transportability and keep tooling options open.

features

• publish on git push using post-receive
• convert inline d2 to diagram
• workflow support for images
• automatic timestamps for published and updated
• content hash and signature
• branch awareness for publish workflow
• automatic nav/back links
• syntax highlighting
  (native pandoc capability for most languages (no d2lang))

design

• Use markdown to provide formatting for capture text.
  
• Use git to synchronise remote text with the server.
• Use git hooks to run publish workflow on push.
• Use pandoc to convert markdown to html
  
• plots using a pandoc filter github
  (pandoc deb had to be installed from git release for the api version to align with pandoc-plot)
• d2 for diagram description site