Skip to content

lggruspe/slipbox

Repository files navigation

slipbox

GitHub Workflow Status PyPI PyPI - Python Version GitHub

slipbox is a static site generator for Zettelkasten notes.

Features

  • Interactive graph of notes and links
  • Static text search
  • Supports notes in markdown, RST, LaTeX, dokuwiki, Org-mode, txt2tags, Textile and MediaWiki formats
  • Checkers/linters for detecting unlinked notes, missing citations, bad formatting and more

Requirements

  • pandoc (2.17+)
  • graphviz
  • python3 (3.8+)

Installation and usage

pip install slipbox

cd my-notes
slipbox init
# ...add notes
slipbox build

See docs-src/index.md and https://lggruspe.github.io/slipbox.

Contributing

See CONTRIBUTING.md.

License

MIT.