jab2870
/
knowledge-base
1
0
Fork 0
Code Issues 6 Pull Requests Projects Releases Wiki Activity
A tool for managing my collection of notes.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2 Commits
1 Branch
0 Tags
1.7 MiB
 
 
 
Tag: Branch: Tree: ac031344d3
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'ac031344d3'
${ noResults }
Go to file
Jonathan Hodgson ac031344d3
Splits up file into smaller files 		4 years ago
inc Splits up file into smaller files 4 years ago
README.md This is the initial commit. See description for what currently works 4 years ago
kb Splits up file into smaller files 4 years ago

README.md

Knowledge Base

This is a script that I use to manage my personal knowledge base. I have yet to find a tool that fits my requirements / desires so I decided to build one.

This is still in early stages of development so expect braking changes to come if you use it.

Goals

Mostly Plain Text

Most of my notes are currently in Markdown. This has a couple of advantages for me:

  • I can read them anywhere
  • I can version control them with Git

There may be some exceptions. I may wish to include links or images which I will version control with Git LFS; but for the most part, my notes are plain text.

Tags

Before starting this project, my notes were organised into folders. Unfortunately, this makes storing articles or notes that apply to different areas difficult. I would prefer a tag based system. This would allow a file to have multiple tags assigned to it.

Fast

I want to be able to retrieve my notes quickly by tag or by title. To do this, this tool will index notes using an SQLite database. This will not be version controlled.

Don't re-invent the wheel

I will be building on top of already great, fast tools such as RipGrep and FZF.