~yonson/mango

A CLI tool for viewing, editing, and storing custom user manuals
Clarify data dir
Missed makefile in cmd change
Adopt cmd directory convention

refs

master
browse  log 

clone

read-only
https://git.sr.ht/~yonson/mango
read/write
git@git.sr.ht:~yonson/mango

You can also use your local clone with git send-email.

  ,ggg,,ggg,,ggg,     ,gggg,gg   ,ggg,,ggg,     ,gggg,gg    ,ggggg,   
 ,8" "8P" "8P" "8,   dP"  "Y8I  ,8" "8P" "8,   dP"  "Y8I   dP"  "Y8ggg
 I8   8I   8I   8I  i8'    ,8I  I8   8I   8I  i8'    ,8I  i8'    ,8I  
,dP   8I   8I   Yb,,d8,   ,d8b,,dP   8I   Yb,,d8,   ,d8I ,d8,   ,d8'  
8P'   8I   8I   `Y8P"Y8888P"`Y88P'   8I   `Y8P"Y8888P"888P"Y8888P"    
                                                    ,d8I'             
                                                  ,dP'8I              
                                                 ,8"  8I              
                                                 I8   8I              
                                                 `8, ,8I              
                                                  `Y8P"               

builds.sr.ht status

#overview

Mango is a CLI tool for viewing, editing, and storing custom user manuals in markdown.

#usage

Create or edit a new mango with the edit command. For example, take some notes on the make tool:

mango edit make

This will open the mango for make with the system's default $EDITOR. Add a user manual in markdown:

# make

* Targets should be marked as PHONY if they do not produce a file of the same
name as the target: `.PHONEY build`

After writing and exiting the editor, the mango will be sync'd with the git repository if one exists in the mango data directory.

You can then view your rendered note when you need it with the show command:

mango show make

#data directory

$HOME/.local/share/mango is the default directory where mangos are stored. This is based on the XDG_DATA_HOME setting.

If data directory is backed by a git repo, mango will automatically commit and sync changes. The git repo must be setup out-of-band by you the user.

You must add your ssh key to your ssh agent for this to work properly.

#install

Mango requires go to be built and can be installed with make:

make install