A simple digital notebook using Markdown.
Project description
Tidynotes
A script to generate a notebook in Markdown. The basic setup is designed around how I take digital notes but should be fairly hackable. I use it to make a single file per day that can then be merged into a single hmtl export or an export for each project I'm working on.
Inside each note:
- There's a single level 1 heading that is the name of the note (generally the day it covers),
- Each project goes under a level 2 heading,
- Tasks within those projects have a level 3 heading,
- Level 4 & 5 headings are optional sub-divisions within those tasks,
The script is designed to be called from the command-line. It takes a directory passed as a positional argument and a number of flags:
-g
/--generate_note
generates a note for the current day,-s
/--make_series
generates notes for n days in the future,-d
/--make_day
generates notes a day specified as a text value,-i
/--initialise_notebook
generates a blank notebook in the directory,-r
/--render_all
merges all markdown files and renders them into a single html output,-c
/--clean_headings
runs a simple heading cleanup routine and runs user-set regex over all notes,-e
/--extract_project
extracts and renders the notes for a specific project,-a
/--extract_all
extracts and renders the notes for all projects,
The script also allows for a few additional features (mainly during cleanup):
- Storing a list of all projects / tasks. This is mainly to allow corrections of misspellings etc.
- A list of regex corrections. The default set:
- Standardises newlines between tasks,
- Newline at the end of each file,
- Homogenises quote marks (e.g. ’ to '),
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
tidynotes-20.1.8.tar.gz
(20.0 kB
view hashes)
Built Distribution
tidynotes-20.1.8-py3-none-any.whl
(26.6 kB
view hashes)
Close
Hashes for tidynotes-20.1.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 965fb8f27db9465ed60729320377286c1fad8bc50a42a5bb46372db074854017 |
|
MD5 | cecf7a0763887304296569578a59042e |
|
BLAKE2b-256 | ebdcfc7b983f4407b2c6a11d2574372e6f54fc9f3a6b3329475bf8417827c526 |