Note taking with reStructuredText

Important

This project is discontinued. Please use tp-note instead. The code of tp-note is generic and works with all markup languages.

Markup languages like reStructuredText are perfectly suited for quick note taking. Type your notes with your favourite editor, view and browse them with Chromium, Chrome or Firefox.

All you need is the so called rst-note ash-script, the python packages restview, docutils, pygments and any browser of your choice: Chromium, Chrome or Firefox.

This is the documentation of the bin/rst-note program. rst-note runs under Linux and Windows. [1] The script operates in four modes depending on it’s options (see ):

New note:Creates a new context depending rst note file. Edit notes:Launches an editor. View notes:Launches a live-previewer (Firefox, Chrome of Chromium). Sync filename:Renames the filename to be in sync with the document’s title.

The project is hosted on Github: restructuredtext-notetaking.

[1]	MacOsX ships with the BSD sed tool which is not compatible with GNU sed. Workaround: run in rst-note in busybox.

Quickstart:

1. Read the installation guide for Linux or Windows.
2. Read about the 2 most common use cases in How students take notes.

Table of contents:

• 1. How students take notes
  • 1.1. The lesson starts
  • 1.2. Taking notes on an existing file
• 2. Create a new note
  • 2.1. Invoking the script
  • 2.2. Directory as parameter
  • 2.3. No parameter
  • 2.4. Filename as parameter
• 3. Editing notes
  • 3.1. Syntax 4
  • 3.2. Example 4
• 4. Viewing notes
  • 4.1. Syntax 5
  • 4.2. Example 5
• 5. Title filename sync
• 6. Installation and configuration
  • 6.1. Linux
  • 6.2. Windows
  • 6.3. Integration with file manager

Indices and tables

• Search Page