Skip to main content

Static-site generator for Zettelkasten notes

Project description

slipbox

slipbox is a collection of tools for managing notes.

Features

  • Citations via pandoc-citeproc
  • Stores notes data in an sqlite database
  • Single-page HTML output with backlinks and Folgezettel links
  • Incremental compilation
  • Fuzzy text search
  • Interactive visualization of Folgezettels

Requirements

  • pandoc
  • python3
  • grep

Installation

pip install slipbox

Usage

python -m slipbox notes.db notes -d ' -o notes.html'

This command create an HTML out of your markdown notes in the notes directory.

  • notes.db is the filename of the sqlite database.
  • notes is your notes directory, must be visible from the working directory.
  • -o notes.html can be replaced with any pandoc option.
    • Take note of the quotes and the leading space.

See docs/ and examples/.

License

MIT.

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

slipbox-0.6.0.tar.gz (20.8 kB view hashes)

Uploaded Source

Built Distribution

slipbox-0.6.0-py3-none-any.whl (32.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page