Crates.io | termbook-cli |
lib.rs | termbook-cli |
version | 1.4.6 |
source | src |
created_at | 2018-02-13 17:22:49.724039 |
updated_at | 2020-04-22 01:20:37.100968 |
description | `termbook` is a command-line tool to build `mdbook`'s while executing `bash` codeblocks and collecting their output to become part of the `mdbook`. |
homepage | https://github.com/Byron/termbook |
repository | https://github.com/Byron/termbook |
max_upload_size | |
id | 51021 |
size | 89,834 |
termbook
is a command-line tool to build mdbook
's while executing
codeblocks and collecting their output to become part of the mdbook
.
This allows to write testable documentation for command-line interfaces.
It came to life for the documentation needs of share-secrets-safely.
Installation documentation can be found here.
termbook
uses termbook
to document itself. Click here for more!
Currently we can only append the output of programs. However, if there was 'replace', we can implement html converters, such as https://github.com/ivanceras/svgbobrus.
That way, diagrams can be written in text, either in the code-block, or in files which are then included via 'include-file'.
termbook
renderer plugin programs for mdbook
Provide all renderers in termbook
as standalone mdbook
compatible plugin
renderers, to allow easier integration with the mdbook
binary.
Depends on https://github.com/rust-lang-nursery/mdBook/issues/631
termbook
preprocessor plugin programs for mdbook
Ideally, we don't have to wrap mdbook
into termbook
. Instead, there should
be plugin-preprocessor support for mdbook
, similar to what's already done
for renderers.
version
in all Cargo.toml
files and git commit
cargo publish
for the library and the CLIgit tag -s <version>
git push --tags origin master
make asciinema-no-upload
make asciinema-upload
make update-homebrew
and commit the changeDocumentation is updated on each push to master.