{"id":18823603,"url":"https://github.com/yvt/svgbobdoc","last_synced_at":"2025-04-09T10:10:17.327Z","repository":{"id":43147144,"uuid":"189161563","full_name":"yvt/svgbobdoc","owner":"yvt","description":"Rust procedural macro that renders ASCII diagrams in doc comments as SVG images.","archived":false,"fork":false,"pushed_at":"2024-11-24T02:35:44.000Z","size":179,"stargazers_count":20,"open_issues_count":6,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-02T09:08:40.378Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/yvt.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE-APACHE","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}},"created_at":"2019-05-29T06:13:04.000Z","updated_at":"2025-03-28T05:25:10.000Z","dependencies_parsed_at":"2024-11-15T17:23:57.277Z","dependency_job_id":"7852ead5-a885-4433-b386-0783a6662892","html_url":"https://github.com/yvt/svgbobdoc","commit_stats":{"total_commits":73,"total_committers":2,"mean_commits":36.5,"dds":"0.013698630136986356","last_synced_commit":"8046e3679c26e138971f93f7f744bb462fcc6629"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yvt%2Fsvgbobdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yvt%2Fsvgbobdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yvt%2Fsvgbobdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yvt%2Fsvgbobdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yvt","download_url":"https://codeload.github.com/yvt/svgbobdoc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248018061,"owners_count":21034048,"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":[],"created_at":"2024-11-08T00:54:09.368Z","updated_at":"2025-04-09T10:10:17.293Z","avatar_url":"https://github.com/yvt.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# svgbobdoc\n\n[\u003cimg src=\"https://docs.rs/svgbobdoc/badge.svg\" alt=\"docs.rs\"\u003e](https://docs.rs/svgbobdoc/)\n\nThis crate provides a procedural macro that renders\nASCII diagrams in doc comments as SVG images using [`svgbob`].\n\n*Requires Rust version 1.73 or later or equivalent nightly builds.*\n\n[`svgbob`]: https://github.com/ivanceras/svgbob\n\n\u003cimg src=\"https://yvt.github.io/svgbobdoc/20190529-zhang_hilbert-2.png\"\n   style=\"border: 10px solid rgba(192, 192, 192, 0.15)\"\u003e\n\n## Usage\n\nAdd the following line to `Cargo.toml`.\n\n```toml\n[dependencies]\nsvgbobdoc = { version = \"0.2\", features = [\"enable\"] }\n```\n\n### `transform!`\n\nWrap doc comments with `#[doc = transform!(...)]`. Use `svgbob` code blocks to write ASCII diagrams.\n\n    #[doc = svgbobdoc::transform!(\n    /// Some structure.\n    ///\n    /// ```svgbob\n    ///  .--------------------.\n    ///  | Diagrams here      |\n    ///  `--------------------'\n    /// ```\n    )]\n    pub struct TestStruct {}\n\n\nSee the `example` directory for a complete example.\n\n### Tips\n\n - Using this macro increases the compilation time. The `enable` Cargo feature can be used to turn off the transformation and the compilation of most dependent packages.\n\n - A link reference definition (`[label]: data:...`) can be generated by providing a link label in a code fence header as in `~~~svgbob,[label]`.\n\nLicense: MIT/Apache-2.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyvt%2Fsvgbobdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyvt%2Fsvgbobdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyvt%2Fsvgbobdoc/lists"}