Git Product home page Git Product logo

zettelkasten's Introduction

Zettelkasten (ZK) guidelines

Introduction to Zettelkasten note-taking method

Useful software (Android)

Markor, a free and versatile markdown editor: GitHub, F-Droid, Google Play

Termux, a unix-like environment for Android: Official site - for git and python3 (see common_actions.py ) to back up your ZK to the remote git storage (optional).


This is a template that represents my vision of a mobile-phone friendly markdown-based ZK. It is imperfect, but it may be useful.

The main key points:

  1. Stick to the main principles of ZK notes:
  • One idea per note.
  • Use your own words.
  • Keep it short and simple.
  • Links are important.
  1. Everything should be linked both ways (links between zettels, zettels and tags, zettels and index, etc). This way one could navigate the database in any direction via the links between files seamlessly.

  2. If you need to copy/paste something - I suggest you to hide it under the spoiler (see template in the bottom).


The principle of contributing to ZK based on this template:

  1. Save the idea to notepad, copy respective source link if required.
  2. Entries for future research go to the todo.
  3. Review, revise, prepare the draft of a zettel from the note.
  4. Create a file for zettel name_it_like_this.md in the ZETTELS folder.
  5. Link zettel with other zettels.
  6. Link other zettels to the zettel.
  7. Optional: Insert sources.
  8. Optional: Link zettel to a tag (create a respective tag .md file in TAGS folder, and link it to zettel, and link zettel to the tag.
  9. Optional: Insert supplementary data (copy-pasta, for instance)

If adding a new entry-point (topic) zettel:

  1. Link zettel in one of the catalogue lists in INDEX folder.
  2. If necessary - create a new catalogue and link it to the main INDEX

Template

Title (name)

Text

Expand / Collapse

links

  1. link1 - description
  2. link2 - description

sources

source1
source2

supplementary

Expand / Collapse Some additional data, such as quotes, numbers, links to images, etc, etc...

tags

tag1, tag2

zettelkasten's People

Contributors

roalyr 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.