{"id":16162803,"url":"https://github.com/msrd0/cargo-doc2readme","last_synced_at":"2025-04-21T11:33:34.509Z","repository":{"id":36966360,"uuid":"364712665","full_name":"msrd0/cargo-doc2readme","owner":"msrd0","description":"cargo subcommand to create a readme file containing the rustdoc comments from your code","archived":false,"fork":false,"pushed_at":"2024-04-29T04:57:14.000Z","size":641,"stargazers_count":25,"open_issues_count":7,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-01T14:51:50.134Z","etag":null,"topics":["cargo","doc2readme","readme","rust","rustdoc"],"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/msrd0.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"msrd0"}},"created_at":"2021-05-05T21:41:55.000Z","updated_at":"2024-05-06T05:31:52.107Z","dependencies_parsed_at":"2023-02-15T11:31:31.076Z","dependency_job_id":"e933a19d-02d9-46b3-a26d-04f724aa5dcb","html_url":"https://github.com/msrd0/cargo-doc2readme","commit_stats":{"total_commits":326,"total_committers":8,"mean_commits":40.75,"dds":0.50920245398773,"last_synced_commit":"a80953839cc6f917117d347b15a04170a900e942"},"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msrd0%2Fcargo-doc2readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msrd0%2Fcargo-doc2readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msrd0%2Fcargo-doc2readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msrd0%2Fcargo-doc2readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/msrd0","download_url":"https://codeload.github.com/msrd0/cargo-doc2readme/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250048102,"owners_count":21366176,"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":["cargo","doc2readme","readme","rust","rustdoc"],"created_at":"2024-10-10T02:33:04.858Z","updated_at":"2025-04-21T11:33:34.490Z","avatar_url":"https://github.com/msrd0.png","language":"Rust","funding_links":["https://github.com/sponsors/msrd0"],"categories":[],"sub_categories":[],"readme":"# This repository has moved to \u003chttps://codeberg.org/msrd0/cargo-doc2readme\u003e\n\n# cargo-doc2readme ![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue) [![cargo-doc2readme on crates.io](https://img.shields.io/crates/v/cargo-doc2readme)](https://crates.io/crates/cargo-doc2readme) [![Source Code Repository](https://img.shields.io/badge/Code-On%20Codeberg-blue?logo=Codeberg)](https://codeberg.org/msrd0/cargo-doc2readme) ![Rust Version: 1.61.0](https://img.shields.io/badge/rustc-1.61.0-orange.svg)\n\n`cargo doc2readme` is a cargo subcommand to create a readme file to display on\n[Codeberg][__link0], [GitHub][__link1] or [crates.io][__link2],\ncontaining the rustdoc comments from your code.\n\n## Installation\n\nIf you are using ArchLinux, you can install cargo-doc2readme from the AUR:\n\n```bash\nyay -S cargo-doc2readme\n```\n\nOn other Operating Systems, make sure you have Rust installed (using your\ndistributions package manager, but if your package manager is garbage or you are\nrunning Windows, try [rustup][__link3]) and then run the following command:\n\n```bash\ncargo install cargo-doc2readme\n```\n\n## Usage\n\nTo generate your readme, simply run\n\n```bash\ncargo doc2readme\n```\n\nThis will output the readme to a file called `README.md`, using `README.j2` or the\nbuilt-in template.\n\nIf you want to run this using Forgejo or GitHub Actions, you can use the pre-built\ndocker image:\n\n```yaml\nreadme:\n  runs-on: ubuntu-latest\n  steps:\n    - uses: actions/checkout@v4\n    - uses: docker://codeberg.org/msrd0/cargo-doc2readme\n      with:\n        entrypoint: cargo\n        args: doc2readme --check\n```\n\nThis will use the latest stable Rust version available when the latest release of\ncargo doc2readme was created. If you need a newer/nightly Rust compiler, use the\n`ghcr.io/msrd0/cargo-doc2readme:nightly` docker image instead.\n\n## Features\n\n* parse markdown from your rustdoc comments and embed it into your readme\n* use existing crates to parse Rust and Markdown\n* support your `[CustomType]` rustdoc links\n* default, minimalistic readme template with some useful badges\n* custom readme templates\n\n## Non-Goals\n\n* verbatim copy of your markdown\n* easy readability of the generated markdown source code\n\n## Similar tools\n\n[`cargo readme`][__link4] is a similar tool. However, it brings its own Rust code\nparser that only covers the 95% use case. Also, it does not support Rust path links\nintroduced in Rust 1.48, making your readme ugly since the unsupported links are shown\nas raw markdown, and being less convenient for the reader that has to search [docs.rs][__link5]\ninstead of clicking on a link.\n\n[`cargo rdme`][__link6] is another tool which places your rustdoc into your readme.\nHowever, it does not come with template support, which is helpful for bigger repositories\nthat contain multiple crates, and has only very basic support for Rust path links. All\nlinks not starting with `crate::` or `::std` are unsupported by `cargo rdme`.\n\n## Stability Guarantees\n\nThis project adheres to semantic versioning. All versions will be tested against the\nlatest stable rust version at the time of the release. All non-bugfix changes to the\nrustdoc input processing and markdown output or the default readme template are\nconsidered breaking changes, as well as any non-backwards-compatible changes to the\ncommand-line arguments or to these stability guarantees. All other changes, including\nany changes to the Rust code, or bumping the MSRV, are not considered breaking changes.\n\n\n [__link0]: https://codeberg.org\n [__link1]: https://github.com\n [__link2]: https://crates.io\n [__link3]: https://rustup.rs/\n [__link4]: https://github.com/webern/cargo-readme\n [__link5]: https://docs.rs\n [__link6]: https://github.com/orium/cargo-rdme\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmsrd0%2Fcargo-doc2readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmsrd0%2Fcargo-doc2readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmsrd0%2Fcargo-doc2readme/lists"}