gronk/readme.md

notes2web

View your notes as a static html site.

Install

0. Install Pandoc and yq

   On arch:

   # pacman -S pandoc yq
   

1. Run make install as root

Usage

$ notes2web NOTES_DIRECTORY_1 [NOTES_DIRECTORY_2 [...]]

The command will generate and place html files in your notes directory. It will then generate a list of all note files and put it in index.html in the root directory.

Then you just have to point a webserver at your notes directory.

Config

notes2web looks for a config file called .notes2web.conf in your current directory and your home directory. Right now the only config available is name:

name="alv"

If the name is not set, the title is set to 'notes'.

Uninstall

# make uninstall