{"id":16376561,"url":"https://github.com/killercup/rust-docstrings","last_synced_at":"2025-07-29T09:32:20.236Z","repository":{"id":56288333,"uuid":"67289503","full_name":"killercup/rust-docstrings","owner":"killercup","description":null,"archived":false,"fork":false,"pushed_at":"2017-06-17T21:04:01.000Z","size":786,"stargazers_count":11,"open_issues_count":6,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-12T03:25:01.081Z","etag":null,"topics":["rust"],"latest_commit_sha":null,"homepage":"https://deterministic.space/machine-readable-inline-markdown-code-cocumentation.html","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/killercup.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-09-03T12:41:43.000Z","updated_at":"2022-07-11T17:21:22.000Z","dependencies_parsed_at":"2022-08-15T16:01:03.696Z","dependency_job_id":null,"html_url":"https://github.com/killercup/rust-docstrings","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/killercup%2Frust-docstrings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/killercup%2Frust-docstrings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/killercup%2Frust-docstrings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/killercup%2Frust-docstrings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/killercup","download_url":"https://codeload.github.com/killercup/rust-docstrings/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227740680,"owners_count":17812687,"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":["rust"],"created_at":"2024-10-11T03:25:08.491Z","updated_at":"2024-12-03T21:32:14.982Z","avatar_url":"https://github.com/killercup.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Markdown doc string parser\n\nThis is a **proof of concept**.\n\nThis Rust library can be used to extract some data from documentation formatted as described [here](https://scribbles.pascalhertleif.de/machine-readable-inline-markdown-code-cocumentation.html).\n\n[![Build Status](https://travis-ci.org/killercup/rust-docstrings.svg?branch=master)](https://travis-ci.org/killercup/rust-docstrings)\n[![Coverage Status](https://coveralls.io/repos/github/killercup/rust-docstrings/badge.svg?branch=master)](https://coveralls.io/github/killercup/rust-docstrings?branch=master)\n\n[Rendered **Documentation** of master branch.](https://killercup.github.io/rust-docstrings/)\n\n## What it does\n\nFor example, given a string like this one:\n\n```markdown\nLorem ipsum\n\nA longer description lorem ipsum dolor sit amet.\n\n# Parameters\n\n- `param1`: Foo\n- `param2`: Bar\n```\n\nit will return structure like this:\n\n```rust\nDocBlock {\n    teaser: \"Lorem ipsum\",\n    description: Some(\"A longer description lorem ipsum dolor sit amet.\"),\n    sections: [\n        Parameters([\n            (\"param1\", \"Foo\"),\n            (\"param2\", \"Bar\")\n        ])\n    ]\n}\n```\n\n## License\n\nLicensed under either of\n\n- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or \u003chttp://www.apache.org/licenses/LICENSE-2.0\u003e)\n- MIT license ([LICENSE-MIT](LICENSE-MIT) or \u003chttp://opensource.org/licenses/MIT\u003e)\n\nat your option.\n\n### Contribution\n\nUnless you explicitly state otherwise, any contribution intentionally\nsubmitted for inclusion in the work by you, as defined in the Apache-2.0\nlicense, shall be dual licensed as above, without any additional terms or\nconditions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkillercup%2Frust-docstrings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkillercup%2Frust-docstrings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkillercup%2Frust-docstrings/lists"}