Home

devpogi notes

My learnings on various subjects.

List

How to build this repo?

docker build -t notes-builder .
docker run --rm -i -v "$PWD":/app notes-builder make

How to add new docs?

Suppose you want to add a new notes dir (say) - kawaii_tech.
Then this dir kawaii_tech should have the following structure and mandatory files (notice the naming of the files too) -

kawaii_tech/kawaii_tech_notes.html

kawaii_tech_notes.html is the file in which your markdown content goes.
Now in the Makefile (of the project’s root dir) add this dir to DIRS_UNSORTED variable.

Tip: You must start your content with a level 1 heading (# something) otherwise, the first para is lost in the render.