Opinionated documentation generator for user defined bash scripts
Switch branches/tags
Nothing to show
Clone or download
Latest commit 2fc0cb3 Dec 10, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src feat(Windows): support for windows filepaths Dec 10, 2018
.gitignore merge conflicts resolved Dec 9, 2018
Cargo.toml move to v0.2.0 Dec 11, 2018
README.md docs(README.md): delimiters change in .bashdocrc Nov 13, 2018
bashdocrc.toml borrowed value does not live long enough Oct 26, 2018
cli.yml new cli option Nov 6, 2018
demo.png updated image in readme Oct 27, 2018
demo2.png better images Oct 23, 2018
example.sh incomplete Nov 24, 2018

README.md

BashDoc

A tool for generating documentation/help menu for user defined bash functions.

Syntax

Example

#;
# cd()
# moves to given directory
# @param directory: folder to move to
# @return void
#"
cd() {
    cd $1
}

Outputs

with lots of color!

Global Delimiters

START_DELIM = #;

END_DELIM = #"

PAR_DELIM = @param

RET_DELIM = @return

OPT_DELIM = # -

COMM_DELIM = #

These can be modifed in your .bashdocrc.

Install

NOTE: Must be on Rust v1.30 or newer.

update with rustup update stable

git clone https://github.com/dustinknopoff/bashdoc
cd bashdoc
cargo install

Usage

bashdoc 1.0
Creates a "javadoc" like structure for bash. See github repo github.com/dustinknopoff/bashdoc for information on
formatting.

USAGE:
    bashdoc [FLAGS] [OPTIONS] <INPUT>

FLAGS:
    -c, --color        toggles color
    -d, --directory    pass a glob pattern to run on.
    -h, --help         Prints help information
    -V, --version      Prints version information

OPTIONS:
    -j, --json <FILE>    print result as JSON

ARGS:
    <INPUT>    Sets the input file to use