Metadata-Version: 2.1
Name: slipbox
Version: 0.10.5
Summary: Static-site generator for Zettelkasten notes
Home-page: https://github.com/lggruspe/slipbox
Author: Levi Gruspe
Author-email: mail.levig@gmail.com
License: UNKNOWN
Description: slipbox
        =======
        
        `slipbox` is a static site generator for Zettelkasten 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` (should be compiled with `pandoc-types` 1.21)
        - `pandoc-citeproc`
        - `python3`
        - `node` (v10.20.1 or above)
        - `better-sqlite3`
        
        Installation
        ------------
        
        ```bash
        npm install -g better-sqlite3
        pip install slipbox
        ```
        
        Usage
        -----
        
        ```bash
        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/](https://lggruspe.github.io/slipbox) for examples.
        
        License
        -------
        
        MIT.
        
        Credits
        -------
        
        This project includes [pandoc.css](https://gist.github.com/killercup/5917178).
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Console
Classifier: Operating System :: POSIX
Requires-Python: >=3.7
Description-Content-Type: text/markdown
