termbook
is a minimal clone of the mdbook
command-line tool, and will only
be required to build the final version of your book as it adds the needed
mdbook
preprocessor.
Installation
Via HomeBrew (OSX and Linux)
This is by far the most straight-forward way of installing termbook. Just execute the following code.
brew tap byron/termbook https://github.com/byron/termbook.git
brew install termbook
Via Github-Releases
At the github releases page you will find precompiled binaries for all common platforms.
Just decompress the respective archive and copy the termbook
binary into your
$PATH
, usually this will be /usr/local/bin
.
Windows is notably absent, but could be provided if there is demand.
Via Cargo
termbook
can be installed via cargo
only, which in turn can be obtained
via rustup
.
Then it's as easy as
cargo install termbook-cli
After the installation...
Now you should be able to run termbook
:
termbook --help
termbook 1.4.6
Sebastian Thiel <byronimo@gmail.com>
`termbook` is a command-line tool to build `mdbook`'s while executing `bash` codeblocks and collecting their output to
become part of the `mdbook`.
USAGE:
termbook [SUBCOMMAND]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
SUBCOMMANDS:
build Build the `mdbook` compatible book in the current working directory or in the given location.
completions generate completions for supported shell
help Prints this message or the help of the given subcommand(s)
play Playback documentation by emulating a fast human typist.
Also have a look at the online documentation at https://byron.github.io/termbook