NOTE: This work has evolved into https://github.com/digitalreplica/conceptual-knowledge
Git-notes is a simple notes system using markdown and git. While git is traditionally a developer tool, it's really simple for anyone to use.
- Create an account on one of the git cloud providers, such as GitHub, GitLab, or Bitbucket
- Create a git repository to store notes in.
- Edit (or create) the README.md file and start adding notes.
Note: Examples are shown using GitHub, but any version of cloud or local git works equally well.
Let's break down the steps in more detail.
A git repository (or repo for short), is simply a collection of files. All changes to files are tracked (like turning on Track Changes in a document.) The contents of the repo are completely up to you. This guide focuses on how to use a repo for human readable notes.
A template is available to make it even easier to start. If you're using GitHub, open git-notes-template and click the Use this template button. With other cloud providers, you can git clone the template repository, or copy-paste the file contents.
When created, a repo must be set as a public or private repo, meaning that other can see it, or only you can. If in doubt, set it to private. It can easily be changed to public later.
Markdown is a human-focused text format, easily readable and writable by anyone. It was created as a way to make web pages without knowing html, so has almost all the features of most word processors.
Markdown files have the extension .md at the end of the filename. Many file editors recognize markdown files, and can automatically show a preview while you're editing with all the formatting applied.
When browsing your note repo through a web browser, git cloud providers automatically display markdown files as web pages with all formatting applied. So you can use your repo as your personal web page. And the special file README.md is automatically displayed when viewing the repo in a web browser. That makes this file perfect for a home page, introduction, or table of contents.
One handy markdown feature is links for linking to other web pages, or using relative links to other notes in your repo. For example, the link to the advanced topics note is written like [advanced topics](advanced_topics.md).
GitHub has a built-in file editor. For an existing file, find the pencil icon to edit that file. To create a few file, click the Add file menu button and select Create new file. Name the file, ending with the extension .md.
Saving new changes to one or more files is called a commit, and is part of the git change tracking feature. Each commit requires a commit message, which is simply a description of what's changed. This be as short or long as you like, and GitHub automatically suggests a commit message when changing a single file.
That's all you need to effectively use the git-notes system.
Once comfortable taking notes, see advanced topics for additional ways to share, protect and organize notes.
Here are other resources and note taking systems that may be helpful.
Niklas Luhmann created a paper-based "Zettelkasten" method of organizing notes, using a numbering system to link them well before the internet was even invented. Getting Started • Zettelkasten Method
Build the Perfect Productivity System with Paper Notebooks and Digital Tools
- 3-tiers:
- fleeting notes: thoughts and ideas during the day
- literature notes: what you learn from others
- permanent notes: digested prose
- lots of links to more references
- mentions "Roam". Looks like the Roam Research at $15/mo
https://notes.andymatuschak.org/About_these_notes
- wow, immense resource
- "garage door up" system of note taking
- “Knowledge and productivity are like compound interest.”
