https://github.com/hackstream/zettel

A notes organizer - based on Zettelkasten methodology.
https://github.com/hackstream/zettel

note-taking zettelkasten-methodology

Last synced: 7 months ago
JSON representation

A notes organizer - based on Zettelkasten methodology.

• Host: GitHub
• URL: https://github.com/hackstream/zettel
• Owner: hackstream
• License: gpl-3.0
• Created: 2020-09-04T08:47:40.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-05-23T13:32:56.000Z (over 4 years ago)
• Last Synced: 2024-08-03T13:05:16.972Z (over 1 year ago)
• Topics: note-taking, zettelkasten-methodology
• Language: Go
• Homepage:
• Size: 783 KB
• Stars: 155
• Watchers: 9
• Forks: 10
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          






  

    

  

  


    


    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](https://zettel.hackstream.dev) `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! :purple_heart:

- [urfave/cli](https://github.com/urfave/cli)

- [knadh/koanf](https://github.com/knadh/koanf)

- [yourbasic/graph](https://github.com/yourbasic/graph)

- [yuin/goldmark](https://github.com/yuin/goldmark)

- [Sigma JS](http://sigmajs.org/)

- [Wing CSS](https://github.com/kbrsh/wing)

## ⭐️ Show your support

Give a :star: 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](CONTRIBUTING.md) for more details.

For a list of things to improve visit [TODO.md](TODO.md)

## License

[GPL v3](license)