You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Adrian Demleitner fde2b5abbf
Delete '.DS_Store'
3 weeks ago
README.md changed readme slightly 1 month ago
backup Adjusted workflow 1 month ago
commit small fix in rsync to pages branch 3 weeks ago
deploy Adjusted workflow 1 month ago
post-render initial commit 9 months ago
render adjustments for easier setups as well as added a readme and license 9 months ago

README.md

pancake.sh

... uses pandoc to render html files from markdown. I choose pandoc because I wanted to keep the toolchain simple and because it can render citations from a bibtex file, which is pretty awesome.

What does it do

The provided scripts recursively renders a folder with its subfolders and markdown files to the same structure into the given folder. It then syncs the given files or assets folder and last but not least, resizes the images in the output folder. It's kind of a static site generator realised with pandoc.

The deploy command takes all the markdown files, and generates an html website from it. It then continues to add the generated files to a specific branch of the git repository which was the input directory.

Setup

  • have pandoc as well as pandoc-citeproc installed - sudo apt install pandoc pandoc-citeproc on something debian/ubuntu based

  • render your markdown archive into a html website through this commond ./deploy -i ../thgie.ch/ -o ../thgie-output/ -t ../thgie.ch/files/template/main.html -b ../thgie.ch/files/Zettelkasten.bib

  • -i input directory, don't forget the trailing slash /

  • -o output directory, again, there is a trailing slash /

  • -t template file, which is used to frame the markdown content

  • -b bibtext file, in case you've got citations in your markdown files

License

Released and distributed under the Anti-Capitalist Attribution Cooperative License.