Archived

This repository has been archived on 2024-01-02. You can view files and clone it, but cannot push or open issues or pull requests.

Alvie Rahman 8dbab1b9f2 add config options for article template, listitem template, index template, stylesheet

2021-05-01 12:21:59 +01:00

1.0 KiB

Raw Blame History

notes2web

View your notes as a static html site.

Install

Install Pandoc and yq

On arch:
```
# pacman -S pandoc yq
```
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. Default config values:

name=""
article_template="/opt/notes2web/templates/article.html"
listitem_template="/opt/notes2web/templates/listitem.html"
index_template="/opt/notes2web/templates/index.html"
stylesheet="/opt/notes2web/styles.css"

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

Uninstall

# make uninstall