{"id":13503147,"url":"https://github.com/Byron/termbook","last_synced_at":"2025-03-29T13:30:51.639Z","repository":{"id":57669482,"uuid":"120078992","full_name":"Byron/termbook","owner":"Byron","description":"A runner for `mdbooks` to keep your documentation tested.","archived":false,"fork":false,"pushed_at":"2020-05-26T13:08:48.000Z","size":974,"stargazers_count":49,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-26T19:07:50.581Z","etag":null,"topics":["cli","cmark","markdown","mdbook","terminal"],"latest_commit_sha":null,"homepage":"https://byron.github.io/termbook","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Byron.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-02-03T09:52:32.000Z","updated_at":"2025-01-10T19:18:30.000Z","dependencies_parsed_at":"2022-09-26T20:40:57.622Z","dependency_job_id":null,"html_url":"https://github.com/Byron/termbook","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Byron%2Ftermbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Byron%2Ftermbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Byron%2Ftermbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Byron%2Ftermbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Byron","download_url":"https://codeload.github.com/Byron/termbook/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245718771,"owners_count":20661161,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","cmark","markdown","mdbook","terminal"],"created_at":"2024-07-31T22:02:38.901Z","updated_at":"2025-03-29T13:30:51.612Z","avatar_url":"https://github.com/Byron.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"[![](http://meritbadge.herokuapp.com/termbook)](https://crates.io/crates/termbook)\n![Rust](https://github.com/Byron/termbook/workflows/Rust/badge.svg)\n\n`termbook` is a command-line tool to build [`mdbook`'s][mdbook] while executing\ncodeblocks and collecting their output to become part of the `mdbook`.\n\nThis allows to write testable documentation for command-line interfaces.\n\nIt came to life for the documentation needs of [share-secrets-safely][sheesy].\n\n[![asciicast](https://asciinema.org/a/163556.png)](https://asciinema.org/a/163556)\n\n[mdbook]: https://github.com/rust-lang-nursery/mdBook\n[sheesy]: https://github.com/Byron/share-secrets-safely\n\n### Installation\n\nInstallation documentation can [be found here][installation-docs].\n\n[installation-docs]: https://byron.github.io/termbook/cli/installation.html#installation\n\n### Documentation\n\n`termbook` uses `termbook` to document itself. [Click here for more!][docs]\n\n[docs]: https://byron.github.io/termbook\n\n### Roadmap\n\n### Add 'replace' support\n\nCurrently we can only append the output of programs. However, if there was 'replace',\nwe can implement html converters, such as https://github.com/ivanceras/svgbobrus.\n\nThat way, diagrams can be written in text, either in the code-block, or in files which\nare then included via 'include-file'.\n\n#### `termbook` renderer plugin programs for `mdbook`\n\nProvide all renderers in `termbook` as standalone `mdbook` compatible plugin\nrenderers, to allow easier integration with the `mdbook` binary.\n\nDepends on https://github.com/rust-lang-nursery/mdBook/issues/631\n\n#### `termbook` preprocessor plugin programs  for `mdbook`\n\nIdeally, we don't have to wrap `mdbook` into `termbook`. Instead, there should\nbe plugin-preprocessor support for `mdbook`, similar to what's already done\nfor renderers.\n\n### Maintenance Guide\n\n#### Making a new release\n\n * **Assure all documentation is up-to-date and tests are green**\n * **Run cargo-clippy and fix all issues**\n * update the `version` in all `Cargo.toml` files and `git commit`\n * run `cargo publish` for the library and the CLI\n * run `git tag -s \u003cversion\u003e`\n * run `git push --tags origin master`\n * **update the asciinema docs**\n   * Set your terminal to a decent size\n   * run `make asciinema-no-upload`\n   * When happy with the result, run `make asciinema-upload`\n   * visit the URL, configure the video, make it public, and copy the \n     markdown link into the README file.\n * **update brew file**\n   * run `make update-homebrew` and commit the change\n \nDocumentation is updated on each push to master.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FByron%2Ftermbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FByron%2Ftermbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FByron%2Ftermbook/lists"}