Skip to content

Quick-Notes Project

Defines a grammar based on markdown that can be converted to and from toml.

This project was created as part of the journal-manager project.

Features

  • Create tagged quick-note markdown entries
  • Convert quick-note from markdown to toml
  • Convert quick-note from toml to markdown

Repository

Quick Notes

Examples

example.md

<!--BEGIN id=0 date="2022-12-30T09:07:33.934408" -->
# 2022-12-30T09:07
I should remember to buy:

- Apples
- Milk
- Sugar

<!--END-->

example.toml

[[list_of_quick_note]]
id = 0
date = "2022-12-30T09:07:33.934408"
title = "2022-12-30T09:07"
text = "I should remember to buy\n\n- Apples\n- Milk\n - Sugar\n\n"

Usage

# Generate toml
quick-notes generate-toml example.md

# Generate markdown
quick-notes generate-markdown example.toml

# Validate both versions againts each other. Overwrite is possible.
quick-notes validate example.toml example.md

# Generate toml quick-note from command-line arguments
quick-notes generate-quick-note --id 1 --date "2022-12-30T10:00:00.000000" --title "Orange Book" "I want to buy the orange book"