kbgen
| Crates.io | kbgen |
| lib.rs | kbgen |
| version | 0.1.1 |
| source | src |
| created_at | 2020-10-20 12:40:48.517415 |
| updated_at | 2020-10-20 12:40:48.517415 |
| description | kbgen is a tool to generate Foam knowledge base documents |
| homepage | https://github.com/jmg-duarte/kbgen |
| repository | https://github.com/jmg-duarte/kbgen |
| max_upload_size | |
| id | 303457 |
| size | 23,844 |
José Duarte (jmg-duarte)
documentation
README
kbgen
kbgen or Knowledge Based Generator is a tool to generate Markdown for a Foam knowledge base.
This tool is highly opinionated and may not fit your personal workflow, however, I welcome any suggestions!
Usage
kbgen has two commands, article and note.
Both commands are preceded by a destination file, if the file exists kbgen will throw an error.
Article
The article command generates a file suited for article summaries.
This command takes the following fields:
| Flag | Name | Description |
|---|---|---|
-t |
Title | The article title |
-a |
Authors | The article authors |
-d / --doi |
DOI | The DOI reference |
Note
The note command generates a file for notes.
As of now, the file is a simple H1 header.
| Flag | Name | Description |
|---|---|---|
-t |
Title | The note title |
Help
To print the help text you can either run kbgen without any arguments or kbgen -h.
Installation
Currently, the only way to install kbgen is by running the following command:
cargo install --git https://github.com/jmg-duarte/kbgen --branch main