hackstream/zettel

Explore the docs »

Report Bug · Request Feature

zettel is a simple FOSS tool to jot down notes using Zettelkasten methodology. The core aim of zettel is to store notes for life. The notes are in simple markdown format which can be published as a static website.

Features

• Generate static website using zettel build.
• No external dependency of any app or SASS vendor lock in for your notes. zettel operates on plain markdown files.
• Generate Connections between notes with a simple syntax.
• Visualise all the connections with a Graph UI.
• No $EDITOR dependency. The markdown notes work same everywhere!

Documentation

This is as meta as it gets. Visit zettel's official documentation hosted on a site created by zettel and not this boring Github README!

Acknowledgements

These amazing FOSS projects helped us build zettel. If you liked zettel, consider spreading some love to these projects as well! 💜

• urfave/cli
• knadh/koanf
• yourbasic/graph
• yuin/goldmark
• Sigma JS
• Wing CSS

⭐️ Show your support

Give a ⭐ if this project helped you!

Contribution

PRs on Feature Requests, Bug fixes are welcome. Feel free to open an issue and have a discussion first. Read CONTRIBUTING.md for more details.

For a list of things to improve visit TODO.md

License

GPL v3