Build Instructions

Dependencies

• You will need binary for lowdown. Build from here.

• You will require binary for sass. Download from here.

make

• Run make from project's root dir to generate all html and css files

• Open index.html in browser

Steps to add new notes directory

• 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.md (your notes in Markdown format)

• Now in the Makefile (of the project's root dir) add this dir to DIRS_UNSORTED variable

Some points to consider while writing notes

• When adding new .md (notes) files, make sure that the fenced code blocks have a language set like -

```cpp
#include <iostream>
using namespace std;
int main()
{
  return 0;
}
```

This will make the <code> tag (in the generated html file) to have class set like -
<code class="language-cpp">