Back to Project List

zettel

A notes organizer - based on Zettelkasten methodology.

Repository Video ▶️

Description

zettel is a FOSS tool to write, organize and publish notes to the web using the popular Zettelkasten methodology. It encompasses a CLI which aids to create new notes in markdown form.

The tool helps you visualize the notes in a non-linear way by creating a DAG structure out of it. These are also called "backlinks". The backlinks help you create a structure "bottom-up" to form a heterarchy (not hierarchy) of your notes.

This tool works with plain markdown files and exports it to static assets like HTML which creates zero lock-in in any proprietary format. You own the data completely and the super simple markdown structure lets you export, maintain backups of your data in any manner you like.

Why would you use this

  • If you don't want to lock in your precious data with a SAAS provider. You don't have to trust this tool to last forever - for your data to outlast you. The data exists in plain boring Markdown files.

  • You don't want to depend just on local CLIs or Text Editors to browse your notes - Use this to publish the notes as a simple static site.

  • You want an opinionated yet productive workflow. This tool is quite blunt about doing just one thing - taking notes using Zettelkasten philosophy. This is not a generic tool to take notes although you can use as one. The real power of this tool lies in the UX while creating and backlinking the notes - it helps you organize your notes in a structured format and visualise the DAG structure of your notes.

Inspiration

The idea of this tool is inspired from Roam Research and while there are multiple OSS projects like Foam - I've not yet found a project which let's me use plain ol' Markdown files yet :)

Karan Sharma
Sarat Chandra

Zettel docs created by zettel itself are live 🎉🎊

https://zettel.hackstream.dev/

Just finishing the video editing and uploading it.

September 13, 2020

🎉 Created a new logo

Worked on adding docs to README. Now setting up a new zettel site, writing a guide for end users and publishing it online (via Github Actions or Netlify).

September 13, 2020

Released v0.1.0 https://github.com/hackstream/zettel

  • Find connections with [[file]] across notes
  • Pipeline html from md
  • CLI to initialise a zettel notebook or cretate notes
  • Basic UI is done which shows "Connections" across notes.
  • Additional graph UI visualization to connect the dots.

September 13, 2020

Able to put together all pieces and have a simple MVP ready. A really simple version of Graph UI is done too for better visualization of notes.

We will now work on creating a documentation website for our own tool using our own tool - such meta much wow.

September 13, 2020

Finished with core templating + markdown->HTML rendering. Basic UI works. Working on creating a Graph UI next thing + minor UI touch ups.

September 12, 2020

Finished with core part of project - moving on to frontend and orchestrating different pieces together.

September 12, 2020

Project created by Karan Sharma

September 4, 2020