{"id":13478109,"url":"https://github.com/badboy/mdbook-open-on-gh","last_synced_at":"2025-10-13T23:34:09.719Z","repository":{"id":40692474,"uuid":"237184309","full_name":"badboy/mdbook-open-on-gh","owner":"badboy","description":"mdbook preprocessor to add a open-on-github link on every page","archived":false,"fork":false,"pushed_at":"2024-05-13T12:11:57.000Z","size":262,"stargazers_count":29,"open_issues_count":1,"forks_count":9,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-10T17:16:39.579Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/badboy.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":"2020-01-30T09:56:35.000Z","updated_at":"2025-05-02T18:28:21.000Z","dependencies_parsed_at":"2023-12-13T11:40:05.746Z","dependency_job_id":"31e92efd-90cd-4045-927f-3cc7866f47e6","html_url":"https://github.com/badboy/mdbook-open-on-gh","commit_stats":{"total_commits":68,"total_committers":4,"mean_commits":17.0,"dds":"0.044117647058823484","last_synced_commit":"a7f81fe6dc008ee76f1de377191ac8d0a855b09e"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"purl":"pkg:github/badboy/mdbook-open-on-gh","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badboy%2Fmdbook-open-on-gh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badboy%2Fmdbook-open-on-gh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badboy%2Fmdbook-open-on-gh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badboy%2Fmdbook-open-on-gh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/badboy","download_url":"https://codeload.github.com/badboy/mdbook-open-on-gh/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badboy%2Fmdbook-open-on-gh/sbom","scorecard":{"id":222817,"data":{"date":"2025-08-11","repo":{"name":"github.com/badboy/mdbook-open-on-gh","commit":"80f114c3a1e8d7a5f8dd1c4127f1972e4d75ed13"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.7,"checks":[{"name":"Code-Review","score":0,"reason":"Found 2/28 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/deploy.yml:1","Warn: no topLevel permission defined: .github/workflows/tests.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/badboy/mdbook-open-on-gh/deploy.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/badboy/mdbook-open-on-gh/deploy.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/badboy/mdbook-open-on-gh/deploy.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy.yml:92: update your workflow using https://app.stepsecurity.io/secureworkflow/badboy/mdbook-open-on-gh/deploy.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy.yml:104: update your workflow using https://app.stepsecurity.io/secureworkflow/badboy/mdbook-open-on-gh/deploy.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy.yml:109: update your workflow using https://app.stepsecurity.io/secureworkflow/badboy/mdbook-open-on-gh/deploy.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy.yml:116: update your workflow using https://app.stepsecurity.io/secureworkflow/badboy/mdbook-open-on-gh/deploy.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/badboy/mdbook-open-on-gh/tests.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/badboy/mdbook-open-on-gh/tests.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/badboy/mdbook-open-on-gh/tests.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/badboy/mdbook-open-on-gh/tests.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/badboy/mdbook-open-on-gh/tests.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/badboy/mdbook-open-on-gh/tests.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/badboy/mdbook-open-on-gh/tests.yml/main?enable=pin","Info:   0 out of   6 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   8 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Mozilla Public License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact 2.4.3 not signed: https://api.github.com/repos/badboy/mdbook-open-on-gh/releases/155493569","Warn: release artifact 2.4.2 not signed: https://api.github.com/repos/badboy/mdbook-open-on-gh/releases/133722620","Warn: release artifact 2.4.1 not signed: https://api.github.com/repos/badboy/mdbook-open-on-gh/releases/115324372","Warn: release artifact 2.4.0 not signed: https://api.github.com/repos/badboy/mdbook-open-on-gh/releases/114791699","Warn: release artifact 2.3.3 not signed: https://api.github.com/repos/badboy/mdbook-open-on-gh/releases/92328601","Warn: release artifact 2.4.3 does not have provenance: https://api.github.com/repos/badboy/mdbook-open-on-gh/releases/155493569","Warn: release artifact 2.4.2 does not have provenance: https://api.github.com/repos/badboy/mdbook-open-on-gh/releases/133722620","Warn: release artifact 2.4.1 does not have provenance: https://api.github.com/repos/badboy/mdbook-open-on-gh/releases/115324372","Warn: release artifact 2.4.0 does not have provenance: https://api.github.com/repos/badboy/mdbook-open-on-gh/releases/114791699","Warn: release artifact 2.3.3 does not have provenance: https://api.github.com/repos/badboy/mdbook-open-on-gh/releases/92328601"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 4 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":5,"reason":"5 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-pg9f-39pc-qf8g","Warn: Project is vulnerable to: RUSTSEC-2025-0024","Warn: Project is vulnerable to: RUSTSEC-2024-0421 / GHSA-h97m-ww89-6jmq","Warn: Project is vulnerable to: GHSA-rr8g-9fpq-6wmg","Warn: Project is vulnerable to: RUSTSEC-2025-0023"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-17T02:59:06.806Z","repository_id":40692474,"created_at":"2025-08-17T02:59:06.806Z","updated_at":"2025-08-17T02:59:06.806Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279010644,"owners_count":26084783,"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","status":"online","status_checked_at":"2025-10-12T02:00:06.719Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-07-31T16:01:52.642Z","updated_at":"2025-10-13T23:34:09.687Z","avatar_url":"https://github.com/badboy.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"# mdbook-open-on-gh\n\nA preprocessor for [mdbook][] to add a open-on-github link on every page.\n\n[mdbook]: https://github.com/rust-lang/mdBook\n\nIt adds an \"Edit this file on GitHub\" link on the bottom of every page, linking directly to the source file.\nIt uses the configured `git-repository-url` as the base.\n\n## Installation\n\nIf you want to use only this preprocessor, install the tool:\n\n```\ncargo install mdbook-open-on-gh\n```\n\nAdd it as a preprocessor to your `book.toml`:\n\n```\n[preprocessor.open-on-gh]\ncommand = \"mdbook-open-on-gh\"\nrenderer = [\"html\"]\n```\n\n## Configuration\n\n`mdbook-open-on-gh` is configured using additional options under `[output.html]`:\n\n\n```toml\n[output.html]\n# Required: Your repository URL used in the link.\ngit-repository-url = \"https://github.com/$user/$project\"\n\n# Your git branch. Defaults to `main`\ngit-branch = \"main\"\n\n# The text to use in the footer.\n# The link text is marked by `[]`\nopen-on-text = \"Found a bug? [Edit this page on GitHub.]\"\n```\n\nTo style the footer add a custom CSS file for your HTML output:\n\n```toml\n[output.html]\nadditional-css = [\"open-in.css\"]\n```\n\nAnd in `open-in.css` style the `\u003cfooter\u003e` element or directly the CSS element id `open-on-gh`:\n\n```css\nfooter {\n  font-size: 0.8em;\n  text-align: center;\n  border-top: 1px solid black;\n  padding: 5px 0;\n}\n```\n\nThis code block shrinks the text size, center-aligns it under the rest of the content\nand adds a small horizontal bar above the text to separate it from the page content.\n\n\nFinally, build your book as normal:\n\n```\nmdbook path/to/book\n```\n\n## License\n\nMPL. See [LICENSE](LICENSE).  \nCopyright (c) 2020-2022 Jan-Erik Rediger \u003cjanerik@fnordig.de\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadboy%2Fmdbook-open-on-gh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbadboy%2Fmdbook-open-on-gh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadboy%2Fmdbook-open-on-gh/lists"}