termbook-cli-1.2.1 is not a library.
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
Installation documentation can be found here.
Documentation
termbook
uses termbook
to document itself. Click here for more!
Roadmap
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.
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.
Maintenance Guide
Making a new release
- Assure all documentation is up-to-date and tests are green
- Run cargo-clippy and fix all issues
- update the
version
in allCargo.toml
files andgit commit
- run
cargo publish
for the library and the CLI - run
git tag -s <version>
- run
git push --tags origin master
documentation is updated on each push to master.