Skip to content

Tool to use Markdown files as zettelkasten knowledge base, like a CLI Obsidian.

Notifications You must be signed in to change notification settings

fdavies93/zenkat-rust

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

42 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ZenKat

(Rocket Powered Crab Edition)

We haven't reached v0.1 release, so this is basically a developer preview.

Dependencies

  • clap for argument parsing
  • crossterm for rendering to terminal
  • tokio for async support
  • reqwest for making requests
  • axum for web server handling
  • serde / serde_json for json parsing

Architecture

Zenkat ships as a collection of utilities. Once we reach a v0.1 release these should be neatly wrapped as the zenkat utility, in a similar way to how apt wraps apt-get, apt-cache and others.

This simplifies parallelising parsing, but also has benefits for code structure.

The following are the utilities targeted for the v0.1 release.

zenkat

A wrapper for the other utilities in the bundle designed to make the apps easier to use.

zk-serve

The main server utility for Zenkat. Allows for querying and manipulation of documents in one or more ZKs / vaults.

For v0.1 release this will be a HTTP server taking JSON requests, but we'd like to allow other I/O methods such as LSP-mode in the future.

zk-cmd

A CLI client utility which allows testing the capabilities of zk-serve using the same interface as other client utilities. This should be considered similar to the mysql client and other database interfaces.

md-parse

The main parser for Zenkat. Takes a single markdown document and parses it into a n-tree structure.

For v0.1 the goal is to support basic Markdown features listed in CommonMark, although not to perfectly implement the CommonMark spec.

FAQs

Why is this called ZenKat?

Because I couldn't remember the word ZEttelKAsTen.

About

Tool to use Markdown files as zettelkasten knowledge base, like a CLI Obsidian.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published