{"id":22556583,"url":"https://github.com/property404/doc2readme","last_synced_at":"2025-03-28T11:17:49.103Z","repository":{"id":213739110,"uuid":"734182130","full_name":"Property404/doc2readme","owner":"Property404","description":"Make a README from rust docs","archived":false,"fork":false,"pushed_at":"2024-01-01T04:20:37.000Z","size":244,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-02T11:41:40.195Z","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":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Property404.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}},"created_at":"2023-12-21T04:19:57.000Z","updated_at":"2023-12-31T18:17:43.000Z","dependencies_parsed_at":"2025-02-02T11:40:40.931Z","dependency_job_id":"173a8e17-96f4-49e9-a910-29d4c31ed834","html_url":"https://github.com/Property404/doc2readme","commit_stats":null,"previous_names":["property404/doc2readme"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Property404%2Fdoc2readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Property404%2Fdoc2readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Property404%2Fdoc2readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Property404%2Fdoc2readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Property404","download_url":"https://codeload.github.com/Property404/doc2readme/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246017724,"owners_count":20710240,"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-12-07T19:13:22.858Z","updated_at":"2025-03-28T11:17:49.080Z","avatar_url":"https://github.com/Property404.png","language":"Rust","readme":"# cargo-doc2readme\n\nConvert crate documention into a README\n\nAlternative to [cargo-readme](https://docs.rs/cargo-readme). Unlike `cargo-readme`,\n`cargo-doc2readme` parses the output of rustdoc instead of extracting the doc comments directly\nfrom the rust source. The main advantage here is that `cargo-doc2readme` can handle relative\nlinks in crate documentation.\n\n## Basic Usage\n\nInstall:\n\n```shell\ncargo install cargo-doc2readme --git https://github.com/Property404/doc2readme\n```\n\nUsage:\n\n```shell\n$ cargo doc2readme -o README.md\n```\n\n## Templating\n\n`cargo-doc2readme` uses [minjinja](https://docs.rs/minijinja) as its\ntemplating engine, which happens to be a superset of `cargo-readme`’s templating engine. Like\n`cargo-readme`, `cargo-doc2readme` uses `README.tpl` as the template by default if it exists,\nbut this can be overridden with the `--template` command line option.\n\nThe default template is:\n\n```jinja\n# {{crate}}\n\n{{readme}}\n{% if license != none %}\n## License\n\n{{license}}\n{% endif %}\n```\n\n### Template variables\n\n* `crate` - the crate name, alias for `package.name`\n* `license` - the crate license, alias for `package.license`\n* `readme` - the generated readme text\n* `version` - the crate version, alias for `package.version`\n* `package` - All package keys\n\n## Todo\n\n* Get dependencies published\n\n## License\n\nGPL-3.0\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fproperty404%2Fdoc2readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fproperty404%2Fdoc2readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fproperty404%2Fdoc2readme/lists"}