https://github.com/lggruspe/slipbox

A static site generator for Zettelkasten notes
https://github.com/lggruspe/slipbox

cli issue-mapping issue-trees knowledge-base knowledge-graph markdown notes pandoc personal-knowledge-base python static-site-generator text-search zettelkasten

Last synced: 3 months ago
JSON representation

A static site generator for Zettelkasten notes

• Host: GitHub
• URL: https://github.com/lggruspe/slipbox
• Owner: lggruspe
• License: mit
• Created: 2020-03-30T12:37:49.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-09-16T14:24:55.000Z (about 1 year ago)
• Last Synced: 2024-04-29T13:31:50.233Z (7 months ago)
• Topics: cli, issue-mapping, issue-trees, knowledge-base, knowledge-graph, markdown, notes, pandoc, personal-knowledge-base, python, static-site-generator, text-search, zettelkasten
• Language: Python
• Homepage: https://lggruspe.github.io/slipbox
• Size: 7.72 MB
• Stars: 55
• Watchers: 3
• Forks: 5
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - lggruspe/slipbox - A static site generator for Zettelkasten notes (Python)

README

        
slipbox

=======

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/lggruspe/slipbox/python-app.yml?branch=master)](https://github.com/lggruspe/slipbox)

[![PyPI](https://img.shields.io/pypi/v/slipbox)](https://pypi.org/project/slipbox/)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/slipbox)](https://pypi.org/project/slipbox/)

[![GitHub](https://img.shields.io/github/license/lggruspe/slipbox)](https://github.com/lggruspe/slipbox)

`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

----------------------

```bash

pip install slipbox

cd my-notes

slipbox init

# ...add notes

slipbox build

```

See [docs-src/index.md](https://github.com/lggruspe/slipbox/blob/master/docs-src/index.md)

and .

Contributing

------------

See [CONTRIBUTING.md](./CONTRIBUTING.md).

License

-------

[MIT](./LICENSE).