mynotes 1.0.1

Installation

Python 3.6+ is required to run mynotes.

The package can be installed directly from PyPi using pip:

pip install mynotes

or downloaded from the release/tags page and then installed using pip:

pip install mynotes-xxx.tar.gz

Excecution

mynotes package contains two scripts for command line interaction.

• mynotes-build builds the index files.

usage: mynotes-build [-h] [--verbose] [--config CONFIG]

Build index files for notes tree.

optional arguments:
-h, --help            show this help message and exit
--verbose, -v         Increase verbosity
--config CONFIG, -c CONFIG
                        Configuration file

• mynotes-genhtml generates HTML files into a dedicated folder.

usage: mynotes-genhtml [-h] [--verbose] [--config CONFIG]

Generate HTML files for markdown files.

optional arguments:
-h, --help            show this help message and exit
--verbose, -v         Increase verbosity
--config CONFIG, -c CONFIG
                        Configuration file

Configuration

mynotes writes the its configuration in a configuration file (.mynotes.ini). This file is created automatically if it does not exist and default configuration values are used.

mynotes takes only into account section [mynotes] thus the configuration could be written in common file, e.g. setup.cfg.

The configuration keys are:

Example of configuration file:

[mynotes]
index = index.md
home = home.md
excl_dirs = .git _files _html
excl_files = .gitignore .python-version index.md Makefile .mynotes.ini
md_ext = .md
plugins_html = links-index toc

License

mynotes is licensed under the GNU General Public License version 3.

See LICENSE.