Notes Website Debut

Release Highlights

• Use lowdown to convert .md to .html
• Use sass to generate .css file
• Use Makefile to automate the build process

Build Instructions

Prebuilt repo

• Download archive notes-0.1.tar.gz or notes-0.1.zip from the Assets
• Extract the downloaded archive
• To see it running ootb as it is, just open index.html in browser

Steps to add new notes directory and then build

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

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

• 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)

  • kawaii_tech/kawaii_tech.mk (copy the contents from linux/linux.mk or rpi/rpi.mk).

    • Set NOTE_NAME in kawaii_tech.mk as

    NOTE_NAME=kawaii_tech_notes
    

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

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

• Open index.html in browser

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">