{"id":15893117,"url":"https://github.com/john-cd/mdbook-utils","last_synced_at":"2025-03-20T12:34:08.037Z","repository":{"id":220647589,"uuid":"751219865","full_name":"john-cd/mdbook-utils","owner":"john-cd","description":"Tools to manage links, reference definitions, and code examples in Markdown files, especially `mdbook` source directories.","archived":false,"fork":false,"pushed_at":"2025-03-13T01:05:59.000Z","size":308,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-13T02:20:06.615Z","etag":null,"topics":["book","links","markdown","mdbook"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/john-cd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-02-01T07:00:44.000Z","updated_at":"2025-03-13T01:04:59.000Z","dependencies_parsed_at":"2024-08-01T18:21:58.116Z","dependency_job_id":"50d2944a-3b68-418d-8bb7-d8d8d304804b","html_url":"https://github.com/john-cd/mdbook-utils","commit_stats":null,"previous_names":["john-cd/mdbook-utils"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/john-cd%2Fmdbook-utils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/john-cd%2Fmdbook-utils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/john-cd%2Fmdbook-utils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/john-cd%2Fmdbook-utils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/john-cd","download_url":"https://codeload.github.com/john-cd/mdbook-utils/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244611574,"owners_count":20481218,"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":["book","links","markdown","mdbook"],"created_at":"2024-10-06T08:07:37.783Z","updated_at":"2025-03-20T12:34:07.686Z","avatar_url":"https://github.com/john-cd.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mdBook Utilities\n\nThis is a **Work In Progress**. The command-line interface (CLI) and underlying API are subject to change. A summary of recently released changes is found in [RELEASES.md](./RELEASES.md). You may also consult [TODO.md](./TODO.md).\n\n## What is `mdbook-utils`? What is it used for?\n\nThe `mdbook-utils` command-line tool manages _links_, _reference definitions_, and _code blocks_ in large collections of Markdown files, especially [`mdbook`][mdbook] source directories. It is the companion tool for the [Rust How-to][rust-howto] book ([github][rust-howto-github]).\n\n`mdbook-utils` is useful for the following:\n\n- centralize all reference definitions in one file to make Markdown files more readable and ease link maintenance,\n- replace simple Markdown links by badges,\n- identify duplicate or broken links,\n- generate a sitemap file for your book or website,\n- extract fenced code bocks embedded into the Markdown to separate files for easier formatting, debugging and testing,\n- replace code examples by mdBook [`#include`][mdbook-include] statements,\n- conversely replace mdBook includes by the file contents.\n\n## Installation and Usage\n\nConsult the [User Guide][mdbook-utils-user-guide] for installation and usage instructions.\n\n## Public API\n\n`mdbook-utils`' underlying library also exposes a [public API][mdbook-utils-docs-rs] that may be used from your code.\n\n## Key Links\n\n`mdbook-utils` [(github)][mdbook-utils-github]  [(docs.rs)][mdbook-utils-docs-rs]  [(crates.io)][mdbook-utils-crates-io]  [(user guide)][mdbook-utils-user-guide]\n\n[mdbook]: https://rust-lang.github.io/mdBook/\n[mdbook-include]: https://rust-lang.github.io/mdBook/format/mdbook.html#including-files\n[mdbook-utils-github]: https://github.com/john-cd/mdbook-utils\n[mdbook-utils-docs-rs]: https://docs.rs/mdbook-utils/latest/mdbook_utils/\n[mdbook-utils-crates-io]: https://crates.io/crates/mdbook-utils\n[mdbook-utils-user-guide]: https://john-cd.github.io/mdbook-utils\n[rust-howto]: https://www.john-cd.com/rust_howto/\n[rust-howto-github]: https://github.com/john-cd/rust_howto\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohn-cd%2Fmdbook-utils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohn-cd%2Fmdbook-utils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohn-cd%2Fmdbook-utils/lists"}