{"id":18700794,"url":"https://github.com/btwiuse/cargo-docs","last_synced_at":"2025-06-14T07:06:29.203Z","repository":{"id":53937072,"uuid":"477512940","full_name":"btwiuse/cargo-docs","owner":"btwiuse","description":"📗Serve rust and crate docs locally","archived":false,"fork":false,"pushed_at":"2025-04-11T23:40:22.000Z","size":148,"stargazers_count":20,"open_issues_count":3,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-08T21:11:23.750Z","etag":null,"topics":["cargo-doc","cargo-plugin"],"latest_commit_sha":null,"homepage":"https://crates.io/crates/cargo-docs","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/btwiuse.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":"2022-04-04T01:31:34.000Z","updated_at":"2025-04-11T23:40:20.000Z","dependencies_parsed_at":"2023-01-30T21:16:00.136Z","dependency_job_id":"2dc5f9e6-6628-4f8b-a29f-d27c421f2c72","html_url":"https://github.com/btwiuse/cargo-docs","commit_stats":{"total_commits":64,"total_committers":4,"mean_commits":16.0,"dds":0.1875,"last_synced_commit":"7cc4c3be0291947e2898b9051bad3173348b39c1"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btwiuse%2Fcargo-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btwiuse%2Fcargo-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btwiuse%2Fcargo-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btwiuse%2Fcargo-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/btwiuse","download_url":"https://codeload.github.com/btwiuse/cargo-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253149616,"owners_count":21861739,"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-doc","cargo-plugin"],"created_at":"2024-11-07T11:39:24.794Z","updated_at":"2025-05-08T21:11:37.134Z","avatar_url":"https://github.com/btwiuse.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"cargo-docs\n==========\n\n[![crates.io](https://img.shields.io/crates/v/cargo-docs.svg)](https://crates.io/crates/cargo-docs)\n[![Documentation](https://docs.rs/cargo-docs/badge.svg)](https://docs.rs/cargo-docs)\n[![Dependency Status](https://deps.rs/repo/github/btwiuse/cargo-docs/status.svg)](https://deps.rs/repo/github/btwiuse/cargo-docs)\n[![Build Status](https://travis-ci.org/btwiuse/cargo-docs.svg?branch=master)](https://travis-ci.org/btwiuse/cargo-docs)\n\nA cargo plugin for serving rust and crate doc locally.\n\n```\n$ cargo docs --help\nUsage: cargo docs [OPTIONS] [EXTRA_ARGS]...\n\nArguments:\n  [EXTRA_ARGS]...  Passthrough extra args to `cargo doc`\n\nOptions:\n      --host \u003cHOST\u003e                    Set host [env: HOST=] [default: 127.0.0.1]\n  -p, --port \u003cPORT\u003e                    Set port [env: PORT=] [default: 8080]\n  -r, --random-port                    Use random port [env: CARGO_DOCS_RANDOM_PORT=true]\n  -s, --search \u003cITEM\u003e                  Search for item\n  -d, --dir \u003cDIR\u003e                      Serve directory content [env: DIR=]\n  -c, --manifest-path \u003cMANIFEST_PATH\u003e  Crate manifest path [default: Cargo.toml]\n  -w, --watch                          Re-generate doc on change [env: CARGO_DOCS_WATCH=]\n  -o, --open                           Open in browser [env: CARGO_DOCS_OPEN=true]\n  -b, --book                           Serve rust book and std doc instead\n  -h, --help                           Print help information\n  -V, --version                        Print version information\n```\n\nBy default, it will call `cargo doc` to build crate doc and start a local server.\n\nAdd `--book` option to see rust doc instead.\n\n## Install\n\n```\n$ cargo install cargo-docs\n```\n\n## Examples\n\nServe crate doc on random port and open in browser  \n```\n$ cargo docs -ro\n[INFO] Serving crate doc on http://127.0.0.1:45669\n[INFO] Opening http://127.0.0.1:45669\n```\n\nSame as above plus automatically rebuild and reload on file changes.\n```\n$ cargo docs -row\n[INFO] Listening for changes...\n[INFO] Serving crate doc on http://127.0.0.1:45669\n[INFO] Opening http://127.0.0.1:45669\n```\n\nServe rust docs instead (roughly the same as [`cargo-book`](https://crates.io/crates/cargo-book))\n```\n$ cargo docs -bro\n[INFO] Serving rust doc on http://127.0.0.1:46661\n[INFO] Opening http://127.0.0.1:46661\n```\n\nSearch for `SocketAddr` in rust std doc served on random port and open it in browser\n```\n$ cargo docs -bros SocketAddr\n[INFO] Serving rust doc on http://127.0.0.1:40143\n[INFO] Opening http://127.0.0.1:40143/std/?search=SocketAddr\n```\n\n## Pro Tips\n\nPassthrough `cargo doc` options after --\n```\n$ cargo docs -- --quiet\n[INFO] Running cargo doc --quiet\n[INFO] Serving crate doc on http://127.0.0.1:8080\n```\n\nIf you are on WSL2, set `BROWSER=/mnt/c/Path/To/Your/Browser.exe` environment variable to open in desktop browser\n```\n$ export BROWSER=\"/mnt/c/Program Files/Firefox Nightly/firefox.exe\"\n```\n\nTired of typing `-o`, `-ro`, `-row`? Try these environment variables to save you some key strokes.\n```\n$ export CARGO_DOCS_OPEN=true\n$ export CARGO_DOCS_WATCH=true\n$ export CARGO_DOCS_RANDOM_PORT=true\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbtwiuse%2Fcargo-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbtwiuse%2Fcargo-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbtwiuse%2Fcargo-docs/lists"}