What is slipbox?

slipbox is a static site generator for Zettelkasten notes.

GitHub: https://github.com/lggruspe/slipbox

Slipbox: https://lggruspe.github.io/slipbox

Source: https://github.com/lggruspe/slipbox/blob/master/docs-src/index.md

#getting-started

• How to install slipbox? [#1]

How to install slipbox?

First, make sure that you have graphviz, pandoc and python installed. Your installation of Pandoc needs to be compiled with pandoc-types 1.22.

Then install using pip.

# Install slipbox.
pip install slipbox

#getting-started

• How to use slipbox? [#2]

How to use slipbox?

# Initialize `slipbox` in your notes directory.
cd my-notes
slipbox init

# Generate site.
slipbox build

# Show help.
slipbox -h

#writing-notes

• How to write notes? [#3]

#view-notes

• How to view the generated site? [#8]

#dot-slipbox

• What does the .slipbox/ directory contain? [#10]

How to write notes?

Slipbox supports many formats: markdown, RST, LaTeX, dokuwiki, Org-mode, txt2tags, Textile and MediaWiki.

A “note” is just a section that begins with a level 1 header. The header must contain an ID (number) and a title. You can put any number of notes in one file.

#writing-notes

• How to link to other notes? [#4]
• How to add citations? [#7]
• Note with timestamp ID [#20200101123000]

How to link to other notes?

Use the note ID as the link target. Ex: link ([link](#100)).

When you omit the link text, it just shows the target ID. Ex: [#100] ([](#100)).

You can also connect notes indirectly by #tagging them.

#writing-notes

• How to link to images? [#5]

How to link to images?

![Example](images/example.png)

How to add citations?

(Cite Author 2020).

To enable citations, you need to specify a bibliography file in .slipbox/config.cfg.

[pandoc-options]
bibliography = example.bib

Click citation links to see the other notes that cite the same reference.

How to view the generated site?

# Generate the site.
slipbox build

# Go to the output directory (public/ by default, see .slipbox/config.cfg).
python -m http.server

# Go to localhost:8000 in your browser.

Tags: #view-notes

What does the .slipbox/ directory contain?

The .slipbox directory contains

• an sqlite3 database (data.db)
• a configuration file (config.cfg).

#dot-slipbox

• Which settings can you configure in ./slipbox/config.cfg? [#11]

Which settings can you configure in ./slipbox/config.cfg?

[note-patterns]
*.md = true
*.markdown = true
*.draft.md = false

Foobar

Foobar.

Note with timestamp ID

You can use a timestamp as a note ID.