{"id":13753794,"url":"https://github.com/boozook/mdbook-svgbob","last_synced_at":"2025-05-16T19:05:52.510Z","repository":{"id":37178382,"uuid":"254838615","full_name":"boozook/mdbook-svgbob","owner":"boozook","description":"SvgBob mdbook preprocessor which swaps code-blocks with neat SVG.","archived":false,"fork":false,"pushed_at":"2025-04-15T14:31:40.000Z","size":261,"stargazers_count":83,"open_issues_count":12,"forks_count":11,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-15T15:36:59.718Z","etag":null,"topics":["ascii-art","markdown","mdbook","mdbook-plugins","preprocessor","svg","svgbob"],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/boozook.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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,"zenodo":null}},"created_at":"2020-04-11T09:57:00.000Z","updated_at":"2025-04-15T14:30:44.000Z","dependencies_parsed_at":"2024-09-07T13:31:35.798Z","dependency_job_id":"ad6b1eb4-e5be-43e4-a990-da67813a0c44","html_url":"https://github.com/boozook/mdbook-svgbob","commit_stats":{"total_commits":14,"total_committers":2,"mean_commits":7.0,"dds":0.1428571428571429,"last_synced_commit":"fdc4f2315d6b7237bb423e29448fdb608f6e656b"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boozook%2Fmdbook-svgbob","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boozook%2Fmdbook-svgbob/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boozook%2Fmdbook-svgbob/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boozook%2Fmdbook-svgbob/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/boozook","download_url":"https://codeload.github.com/boozook/mdbook-svgbob/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254592368,"owners_count":22097011,"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":["ascii-art","markdown","mdbook","mdbook-plugins","preprocessor","svg","svgbob"],"created_at":"2024-08-03T09:01:29.726Z","updated_at":"2025-05-16T19:05:52.501Z","avatar_url":"https://github.com/boozook.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"# Svgbob plugin for mdbook\n\n[Svgbob][]-based preprocessor for [mdbook][] transform your ascii diagrams into a svg.\n\nThis renders a code-block marked `bob` into neat svg diagrams and inline it into the output.\n\n\n## Usage\n\nFirstly add the following to your book's manifest file\n(usually `book.toml`)\n\n```toml\n[preprocessor.svgbob] # all fields by default\n```\nSee [config](#config) for more information.\n\n\nAdd some ascii graphics:\n\n_chapter_1.md_\n````md\n```bob\n    0       3\n     *-------*      +y\n  1 /|    2 /|       ^\n   *-------* |       |\n   | |4    | |7      | ◄╮\n   | *-----|-*     ⤹ +-----\u003e +x\n   |/      |/       / ⤴\n   *-------*       v\n  5       6      +z\n```\n````\n\nBuild your book and open:\n```\nmdbook build\nopen book/index.html\n```\n\n### Config\n\nDefault preprocessor config:\n\n```toml\n[preprocessor.svgbob]\n# svgbob configuration:\n# doc: https://docs.rs/svgbob/latest/svgbob/struct.Settings.html\n# default values: https://github.com/ivanceras/svgbob/blob/master/packages/svgbob/src/settings.rs#L29-L38\nfont_size = 14\nfont_family = \"Iosevka Fixed, monospace\"\nfill_color = \"black\"\nbackground = \"transparent\"               # default overridden, differs from svgbob's default\nstroke_color = \"var(--fg)\"               # default overridden, differs from svgbob's default\nstroke_width = 2.0\nscale = 8.0\ninclude_backdrop = true\ninclude_styles = true\ninclude_defs = true\n\n# preprocessor configuration:\ncode_block = \"bob\"                       # render only code-blocks marked as \"bob\", e.g.: ```bob\n```\n\nAll properties are optional.\n\nSee [svgbob's settings doc](https://docs.rs/svgbob/latest/svgbob/struct.Settings.html) and [default values](https://github.com/ivanceras/svgbob/blob/master/packages/svgbob/src/settings.rs#L29-L38]).\n\n\n- - -\n\n\nFor more information about mdbook see [mdbook manual][mdbook.manual],\n[svgbob spec][svgbob.spec] and [editor][svgbob.editor].\n\n\n## Contribution\n\nContributions are appreciated.\nDon't hesitate to participate to discussions in the issues, propose new features and ask for help.\n\n\nUseful hint for one-command builds crate + book:\n\n1. add `command` to the manifest:\n\n```toml\n# book.toml\n\n[preprocessor.svgbob]\ncommand = \"cargo run --manifest-path /path/to/mdbook-svgbob/Cargo.toml --quiet\"\n```\n\n2. So then you only need to rebuild the book. Run something like this:\n\n```bash\nRUST_LOG=mdbook_svgbob=trace mdbook build\n```\n\n\n[Rust]: https://www.rust-lang.org\n[Rustup]: https://rustup.rs\n\n[mdbook]: https://crates.io/crates/mdbook\n[mdbook.manual]: https://rust-lang.github.io/mdBook/\n\n[Svgbob]: https://crates.io/crates/svgbob\n[svgbob.spec]: https://ivanceras.github.io/#md/Svgbob/Specification.md\n[svgbob.editor]: https://ivanceras.github.io/svgbob-editor/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboozook%2Fmdbook-svgbob","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboozook%2Fmdbook-svgbob","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboozook%2Fmdbook-svgbob/lists"}