{"id":15031014,"url":"https://github.com/erb3/markdown-builder","last_synced_at":"2025-04-09T22:41:12.898Z","repository":{"id":257272228,"uuid":"853820559","full_name":"Erb3/markdown-builder","owner":"Erb3","description":"Opinionated Rust crate for building markdown documents","archived":false,"fork":false,"pushed_at":"2025-04-02T18:25:34.000Z","size":132,"stargazers_count":2,"open_issues_count":4,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-02T19:29:49.197Z","etag":null,"topics":["hacktoberfest","markdown","markdown-builder","rust","rust-lang"],"latest_commit_sha":null,"homepage":"https://docs.rs/markdown-builder","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Erb3.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":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-07T16:18:48.000Z","updated_at":"2025-04-02T18:25:38.000Z","dependencies_parsed_at":"2024-10-28T16:08:22.943Z","dependency_job_id":"03ad3998-bb64-4687-86b7-b76f4ae06dc4","html_url":"https://github.com/Erb3/markdown-builder","commit_stats":{"total_commits":56,"total_committers":2,"mean_commits":28.0,"dds":0.4107142857142857,"last_synced_commit":"1b0e4523a115ef2672c211ca834f48f32b6eec65"},"previous_names":["erb3/markdown-builder"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Erb3%2Fmarkdown-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Erb3%2Fmarkdown-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Erb3%2Fmarkdown-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Erb3%2Fmarkdown-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Erb3","download_url":"https://codeload.github.com/Erb3/markdown-builder/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248124848,"owners_count":21051757,"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":["hacktoberfest","markdown","markdown-builder","rust","rust-lang"],"created_at":"2024-09-24T20:14:43.947Z","updated_at":"2025-04-09T22:41:12.880Z","avatar_url":"https://github.com/Erb3.png","language":"Rust","readme":"# Markdown Builder\n\n**markdown-builder** is an opinionated Rust crate for programmatically building\nmarkdown documents. This project is based of the [markdown-composer] crate by\n[mainrs].\n\n```shell\ncargo add markdown-builder\n```\n\n## Features\n\n- Headers\n- Paragraphs\n  - Word wrapping\n- Images\n  - Footer\n  - Alt text\n- Links\n  - Footer\n- Lists\n  - Ordered\n  - Unordered\n  - Checkboxes\n- Transformations\n  - Italic\n  - Bold\n  - Strikethrough\n  - Codeblocks\n  - Inline code\n  - Blockquote\n\n## Usage\n\n\u003e [!NOTE]\n\u003e The builders will often panic when you try to do stupid things.\n\u003e If you create the structs directly, it will not panic, resulting in potentially invalid markdown.\n\nTo fully get the gripe of markdown-builder, a good starting point is the\n[documentation](https://docs.rs/markdown-builder/latest/markdown_builder/) or\nunit tests. Here however, is a simple example.\n\n```rust\nlet mut doc = Markdown::new();\n\ndoc.image(\n  ImageBuilder::new()\n    .url(\"https://example.com/picture.png\")\n    .text(\"A cute picture of a sandcat\")\n    .footer()\n    .build(),\n);\n\ndoc.paragraph(\"Hello World\");\n\nprintln!(\"output: {}\", doc.render())\n```\n\n## Why fork?\n\nThis project was forked out of markdown-composer due to a multitude of reasons:\n\n- **Fun**\n- Markdown-composer looked unmaintained\n- Not wanting the additional settings to make it work for everyone\n- Word wrapping\n\n[markdown-composer]: https://github.com/mainrs/markdown-composer-rs\n[mainrs]: https://github.com/mainrs\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferb3%2Fmarkdown-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ferb3%2Fmarkdown-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferb3%2Fmarkdown-builder/lists"}