{"id":20358827,"url":"https://github.com/creativcoder/cargo-docco","last_synced_at":"2025-04-12T03:22:52.497Z","repository":{"id":57534302,"uuid":"310514771","full_name":"creativcoder/cargo-docco","owner":"creativcoder","description":"cargo docco generates literate programming style documentation pages from source code. Port of Jash Kenas' Docco in Rust.","archived":false,"fork":false,"pushed_at":"2020-11-06T11:09:37.000Z","size":18275,"stargazers_count":8,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-09T12:38:50.041Z","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/creativcoder.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"creativcoder","liberapay":"creativcoder","custom":["https://www.buymeacoffee.com/creativcoder"]}},"created_at":"2020-11-06T06:46:00.000Z","updated_at":"2024-10-07T15:09:09.000Z","dependencies_parsed_at":"2022-09-26T18:21:28.061Z","dependency_job_id":null,"html_url":"https://github.com/creativcoder/cargo-docco","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/creativcoder%2Fcargo-docco","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/creativcoder%2Fcargo-docco/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/creativcoder%2Fcargo-docco/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/creativcoder%2Fcargo-docco/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/creativcoder","download_url":"https://codeload.github.com/creativcoder/cargo-docco/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248510703,"owners_count":21116253,"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-14T23:29:03.412Z","updated_at":"2025-04-12T03:22:52.472Z","avatar_url":"https://github.com/creativcoder.png","language":"Rust","readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg alt=\"rocco\" width=\"250\" src=\"assets/cargo-docco.png\" /\u003e\n\u003ch1\u003ecargo docco\u003c/h1\u003e\n\u003cp\u003ecargo docco generates literate programming style \ndocumentation pages.\u003c/p\u003e\n\n[![Actions Status](https://github.com/creativcoder/cargo-docco/workflows/ci/badge.svg)](https://github.com/creativcoder/cargo-docco/actions)\n[![crates.io](https://img.shields.io/crates/v/cargo-docco.svg)](https://crates.io/crates/cargo-docco)\n[![license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/creativcoder/avrow/blob/master/LICENSE-MIT)\n[![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/creativcoder/avrow/blob/master/LICENSE-APACHE)\n\n\u003c/div\u003e\n\n## In action\n\n![docco in action](assets/docco_cast.gif)\n\n## Installation\n\n```sh\n$ cargo install cargo-docco\n```\n\n(Please check [`cargo`'s documentation](http://doc.crates.io/) to learn how `cargo install` works and how to set up your system so it finds binaries installed by `cargo`.)\n\n## Usage\n\nGenerating documentation pages is as simple as providing cargo docco an input file via `-i` flag.\n\n```\ncargo docco -i source.rs [-o \u003coptional output file name\u003e]\n```\n\nWhen no output file is provided, cargo docco will generate an html file name\nsame as the source file name.\n\n## CLI overview\n\n```plain\n\u003e cargo docco -h\ncargo-docco 0.1.0\nLiterate-style documentation generator from source code\n\nUSAGE:\n    cargo docco [OPTIONS] -i \u003cinput\u003e\n\nFLAGS:\n    -h, --help       Prints help information\n    -V, --version    Prints version information\n\nOPTIONS:\n    -i \u003cinput\u003e         input source file\n    -o \u003coutput\u003e        optional path to the generated output html file\n```\n\n## Supported languages\ncargo-docco relies on [rocco](https://github.com/creativcoder/rocco). See \"Supported languages\" section for supported languages.\n\n## Contribution\n\nAll kinds of contributions are welcome.\n\nQuestions can be asked in [issues](https://github.com/creativcoder/cargo-docco/issues).\n\nTo help us help you get pull requests merged quickly and smoothly, open an issue before submitted large changes. Please keep the contents of pull requests and commits short. Commit messages should include the intent of the commit.\n\n## Support\n\n\u003ca href=\"https://www.buymeacoffee.com/creativcoder\" target=\"_blank\"\u003e\u003cimg src=\"https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png\" alt=\"Buy Me A Coffee\" style=\"height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;\" \u003e\u003c/a\u003e\n\n[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/P5P71YZ0L)\n\n## License\n\nDual licensed under either of Apache License, Version 2.0 or MIT license at your option.\n\nUnless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.","funding_links":["https://github.com/sponsors/creativcoder","https://liberapay.com/creativcoder","https://www.buymeacoffee.com/creativcoder","https://ko-fi.com/P5P71YZ0L"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcreativcoder%2Fcargo-docco","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcreativcoder%2Fcargo-docco","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcreativcoder%2Fcargo-docco/lists"}