Skip to content

brest-computer-club/knowledge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Knowledge

Knowledge let's you transform your markdown files into a knowledge base

Installation

  • Download a release
  • Make it executable
  • Launch it in any folder containing your notes

Your (default) web browser will open and let you browse your files by tags

Expected markdown format

A yaml header containing at least a title and a tag is required :

---
title: Knowledge transform your markdown files into a knowledge base 
tags:
- rust
- elm
- markdown
- GPL licence
---

# My markdown content 
...

Supported features

  • walk all sub-directories and discover all well-formatted files
  • handle relative links between "articles"
  • handle local and distant images
  • use a random port to avoid conflicts
  • more complex tag combination search
  • update on file change

TODO

  • handle local svg
  • update frontend on change
  • cross-compile to OSX & Windows

Develop

a nix-shell is available at the root of this folder

front

start the backend with the flag -d, then

make front-serve

About

transform a folder full of markdown files into a knowledge base

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •