alvierahman90/notes2web
Archived
1
1
Fork 0
Code Issues 5 Pull Requests Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Akbar Rahman 2021-06-29 20:27:32 +01:00
parent 700709f171
commit 42d0775fe6
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
readme.md
View File

@ -19,11 +19,11 @@ doing it for me:
## Install ## Install
0. Install [Pandoc](https://pandoc.org/index.html) 0. Install [Pandoc](https://pandoc.org/index.html) and [Pip](https://github.com/pypa/pip)
On arch: On arch:
``` ```
# pacman -S pandoc # pacman -S pandoc python-pip
``` ```
1. Run `make install` as root 1. Run `make install` as root
@ -31,7 +31,7 @@ doing it for me:
## Usage ## Usage
``` ```
$ notes2web.py NOTES_DIRECTORY_1 $ notes2web.py notes_directory
``` ```
Output of `notes2web.py --help`: Output of `notes2web.py --help`:
@ -40,7 +40,7 @@ Output of `notes2web.py --help`:
usage: notes2web.py [-h] [-o OUTPUT_DIR] [-t TEMPLATE] [-H TEMPLATE_TEXT_HEAD] usage: notes2web.py [-h] [-o OUTPUT_DIR] [-t TEMPLATE] [-H TEMPLATE_TEXT_HEAD]
[-f TEMPLATE_TEXT_FOOT] [-i TEMPLATE_INDEX_HEAD] [-f TEMPLATE_TEXT_FOOT] [-i TEMPLATE_INDEX_HEAD]
[-I TEMPLATE_INDEX_FOOT] [-s STYLESHEET] [-I TEMPLATE_INDEX_FOOT] [-s STYLESHEET]
[-e EXTRA_INDEX_CONTENT] [-e EXTRA_INDEX_CONTENT] [-n INDEX_ARTICLE_NAMES]
notes notes
positional arguments: positional arguments:
@ -56,6 +56,7 @@ optional arguments:
-I TEMPLATE_INDEX_FOOT, --template-index-foot TEMPLATE_INDEX_FOOT -I TEMPLATE_INDEX_FOOT, --template-index-foot TEMPLATE_INDEX_FOOT
-s STYLESHEET, --stylesheet STYLESHEET -s STYLESHEET, --stylesheet STYLESHEET
-e EXTRA_INDEX_CONTENT, --extra-index-content EXTRA_INDEX_CONTENT -e EXTRA_INDEX_CONTENT, --extra-index-content EXTRA_INDEX_CONTENT
-n INDEX_ARTICLE_NAMES, --index-article-names INDEX_ARTICLE_NAMES
``` ```
The command will generate a website in the `output-dir` directory (`./web` by default). The command will generate a website in the `output-dir` directory (`./web` by default).