https://github.com/BharatKalluri/gardener

A command line tool to help you manage your Knowledge management system / Digital Garden ᵃˡᵖʰᵃ
https://github.com/BharatKalluri/gardener

knowledge-base knowledge-management note-taking

Last synced: 5 days ago
JSON representation

A command line tool to help you manage your Knowledge management system / Digital Garden ᵃˡᵖʰᵃ

• Host: GitHub
• URL: https://github.com/BharatKalluri/gardener
• Owner: BharatKalluri
• License: gpl-3.0
• Created: 2020-06-09T04:59:17.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-04-01T17:07:51.000Z (over 3 years ago)
• Last Synced: 2024-08-02T12:44:52.312Z (3 months ago)
• Topics: knowledge-base, knowledge-management, note-taking
• Language: Python
• Homepage:
• Size: 48.8 KB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - BharatKalluri/gardener - A command line tool to help you manage your Knowledge management system / Digital Garden ᵃˡᵖʰᵃ (others)

README

        


  
Gardener 🌱

  
A simple command line tool to maintain your digital garden.








   

    

   





     Report a problem! 



> Note: This is still an alpha product

Gardener is a command line tool meant to organize your digital garden.

The aim of this tool is to **get out of the way and make managing a digital garden editor/service independent.**

## Installation

You will need to install python and pip on your system.

```

pip install --user https://github.com/BharatKalluri/gardener/releases/download/0.1/gardener-0.1.0.tar.gz

```

[Will publish to pypi soon](https://github.com/BharatKalluri/gardener/issues/14)

## What can it do?

Create a `readme.md`. This will serve as an entry point for your notes. Write notes in markdown, use wiki-links (`[[file-name]]`) to link between notes.

- `gardener link` : Converts all wiki links to markdown links (so that github pages can pick these up as normal web links)

- `gardener rename  `: Will rename a note and also the corresponding wiki links

- `gardener tend`: Will scan all your notes and find out which notes are not linked and will automatically create wiki links for you (coming soon in release 0.2!)

Push the updated files and switch on github pages if you please. You will have a great looking website ready for you! ([example](https://notes.bharatkalluri.in))

> Pro tip: Setup a pre-commit hook so that all your will have up to date backlinks/wikilinks. I use [lefthook](https://github.com/Arkweid/lefthook/)

     personally, The config is [very simple!](https://github.com/BharatKalluri/notes/blob/master/lefthook.yml)

### What is planned?

- A graph view between all your wiki links.

    

### Limitations

- Although gardener handles files in nested folders, it cannot handle files having the same name.

    

Please do let me know if you have any other interesting ideas over at github issues!