Organize your notes using your favorite editor and markup-language.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
doc
.gitignore
LICENSE
README.md
make_dist

README.md

title author date
README
Jens Getreu
2017-08-09

Markup languages like Markdown, ReStructuredText, textile, txt2tags or mediawiki are perfectly suited for fast note taking. Type your notes with your favorite editor, using your favorite markup language[^1] and view them with Chromium, Chrome or Firefox[^2].

All you need is the pandoc-note script, the Pandoc format converter, an editor of your choice and Chromium, Chrome or Firefox as live previewer. If not available, pandoc-note also works without pandoc.

pandoc-note runs under Linux and Windows. The script operates in four modes depending on it’s options (see [Invoking pandoc-note]):

Create a new note

  • creates a new context depending notes-plain-text-file with an YAML metadata header.

Edit notes

  • detects the markup-language of the note file, converts to html, launches an editor and a live-previewer (Firefox, Chrome or Chromium).

View notes

  • detects the markup-language of the note file, converts to html and launches a live-previewer (Firefox, Chrome or Chromium).

Sync filename

  • renames the filename to be in sync with the document’s YAML metadata header.

The project is hosted on Github: getreu/pandoc-notetaking. The project’s webpage is on http://blog.getreu.net. There you also find a pdf rendition of this document.

[^1]: pandoc-note supports all Pandoc's plain text input formats (see: pandoc --list-input-formats). pandoc-note guesses the markup language from the file extension of the text file. Currently md, markdown, mkd, rst, rest, txt, t2t, textile, twiki and mediawiki are supported.

[^2]: As alternative editors with build-in previewer are supported.