Git Product home page Git Product logo

zettelkast's Introduction

Zettelkast

Command-line tool for managing zettelkast documents. The tool primarily focuses on providing unique ids and showing a graph of document connections. It tries to be as unintrusive as possible.

The only requirement is setting the ZETTELKAST_ROOT environment variable to where you want to store your zettels.

What is a zettelkast zettel

A zettelkast zettel is just a normal markdown file with a unique zettelkast style filename. Aside from the filename, you can write your normal everyday markdown with no special consideration of any kind.

  • The first layer of header1 is used as the title when listing with zettelkast list
  • Any links across zettels are just normal links to files. No special syntax or identifiers needed.

Creating a new zettel

$ zettelkast new

It will open your $EDITOR with the filename, defaulting to vim.

Showing the document graph

$ zettelkast graph | sfdp -x -Goverlap=scale -Txlib

The zettelkast graph command will output the connections graph as a dot output, you can pipe it to graphviz to render it.

zettelkast's People

Contributors

masser avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.