Archived

View your notes as a static html site. https://notes.alv.cx

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.

Go to file

Alvie Rahman c7b04653cb add extra content to notes landing page		2021-06-29 19:06:34 +01:00
templates	add extra content to notes landing page	2021-06-29 19:06:34 +01:00
.gitignore	add .gitignore	2021-06-29 14:11:30 +01:00
.notes2web.conf	add development config	2021-05-01 13:05:22 +01:00
Makefile	fix makefile	2021-06-29 14:58:22 +01:00
notes2web.py	add extra content to notes landing page	2021-06-29 19:06:34 +01:00
readme.md	convert script to python	2021-06-29 14:35:21 +01:00
requirements.txt	convert script to python	2021-06-29 14:35:21 +01:00
screenshot.png	add yq depencency, screenshot	2021-05-01 12:04:45 +01:00
styles.css	add blockquote styling	2021-06-29 19:04:42 +01:00

readme.md

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.py NOTES_DIRECTORY_1 [NOTES_DIRECTORY_2 [...]]

The command will generate a website in the $output directory (./web by default). It will then generate a list of all note files and put it in index.html.

Then you just have to point a webserver at $output.

Config

NOT CURRENTLY IMPLEMENTED

notes2web looks for a config file called .notes2web.conf in your current directory and your home directory. Default config values:

name="" # your name
output="web" # the folder where the website will be generated in
article_template="/opt/notes2web/templates/article.html"
textarticlehead_template="/opt/notes2web/templates/textarticlehead.html"
textarticlefoot_template="/opt/notes2web/templates/textarticlefoot.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