jab2870/knowledge-base
1
0
Fork 0
Code Issues 6 Pull requests Projects Releases Wiki Activity
A tool for managing my collection of notes.
5 commits 1 branch 0 tags 1.7 MiB
Find a file
Jonathan Hodgson 04367ae776 Adds update command for externally modified files 
This can be used when a file is modified externally. It will update the
sqlite database and potentially run git commands for the change.

If there are 2 files provided, it assumes that the file was moved. The
first filename should be the old file.

The new, edit and delete functions were also re factored slightly to use
this new update function.

Relevant to issue #4
Close issue #1
2020-12-20 20:03:25 +00:00
inc Adds update command for externally modified files 2020-12-20 20:03:25 +00:00
kb Adds update command for externally modified files 2020-12-20 20:03:25 +00:00
README.md This is the initial commit. See description for what currently works 2020-12-19 15:52:27 +00:00

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.