{"id":17956085,"url":"https://github.com/bojand/mdpage","last_synced_at":"2025-11-26T15:02:57.145Z","repository":{"id":57637599,"uuid":"231139354","full_name":"bojand/mdpage","owner":"bojand","description":"Simple documentation tool","archived":false,"fork":false,"pushed_at":"2020-03-17T01:07:54.000Z","size":153,"stargazers_count":3,"open_issues_count":7,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-11T02:43:48.473Z","etag":null,"topics":["documentation","hacktoberfest"],"latest_commit_sha":null,"homepage":"https://bojand.github.io/mdpage","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/bojand.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"custom":["https://www.paypal.me/bojandj","https://www.buymeacoffee.com/bojand"]}},"created_at":"2019-12-31T19:40:29.000Z","updated_at":"2025-03-13T09:38:17.000Z","dependencies_parsed_at":"2022-09-02T03:20:58.183Z","dependency_job_id":null,"html_url":"https://github.com/bojand/mdpage","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/bojand/mdpage","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bojand%2Fmdpage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bojand%2Fmdpage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bojand%2Fmdpage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bojand%2Fmdpage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bojand","download_url":"https://codeload.github.com/bojand/mdpage/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bojand%2Fmdpage/sbom","scorecard":{"id":247074,"data":{"date":"2025-08-11","repo":{"name":"github.com/bojand/mdpage","commit":"c79fa753382d1332894b93e3e589d6030e059af9"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.1,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/30 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":"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":"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":"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":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/build.yml:1","Warn: no topLevel permission defined: .github/workflows/docs.yml:1","Warn: no topLevel permission defined: .github/workflows/release.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/build.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/bojand/mdpage/build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/bojand/mdpage/docs.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/bojand/mdpage/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/bojand/mdpage/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/bojand/mdpage/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/bojand/mdpage/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:74: update your workflow using https://app.stepsecurity.io/secureworkflow/bojand/mdpage/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/bojand/mdpage/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/bojand/mdpage/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:90: update your workflow using https://app.stepsecurity.io/secureworkflow/bojand/mdpage/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:107: update your workflow using https://app.stepsecurity.io/secureworkflow/bojand/mdpage/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:125: update your workflow using https://app.stepsecurity.io/secureworkflow/bojand/mdpage/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:126: update your workflow using https://app.stepsecurity.io/secureworkflow/bojand/mdpage/release.yml/master?enable=pin","Warn: goCommand not pinned by hash: .github/workflows/release.yml:102","Info:   0 out of   9 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   4 third-party GitHubAction dependencies pinned","Info:   0 out of   1 goCommand 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":"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache 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":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v0.1.3 not signed: https://api.github.com/repos/bojand/mdpage/releases/22951827","Warn: release artifact v0.1.2 not signed: https://api.github.com/repos/bojand/mdpage/releases/22951654","Warn: release artifact v0.1.1 not signed: https://api.github.com/repos/bojand/mdpage/releases/22777051","Warn: release artifact v0.1.3 does not have provenance: https://api.github.com/repos/bojand/mdpage/releases/22951827","Warn: release artifact v0.1.2 does not have provenance: https://api.github.com/repos/bojand/mdpage/releases/22951654","Warn: release artifact v0.1.1 does not have provenance: https://api.github.com/repos/bojand/mdpage/releases/22777051"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"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":"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"}}]},"last_synced_at":"2025-08-17T07:47:43.785Z","repository_id":57637599,"created_at":"2025-08-17T07:47:43.786Z","updated_at":"2025-08-17T07:47:43.786Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286079811,"owners_count":27282121,"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-11-26T02:00:06.075Z","response_time":193,"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":["documentation","hacktoberfest"],"created_at":"2024-10-29T10:34:34.120Z","updated_at":"2025-11-26T15:02:57.129Z","avatar_url":"https://github.com/bojand.png","language":"Rust","funding_links":["https://www.paypal.me/bojandj","https://www.buymeacoffee.com/bojand"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\t\u003cbr\u003e\n\t\u003cimg src=\"docs/static/logo-192x192.png\" alt=\"Logo\" width=\"96\" height=\"96\"\u003e\n\t\u003cbr\u003e\n\u003c/div\u003e\n\n# mdpage\n\n\u003e Simple documentation tool\n\n[![Build Status](https://github.com/bojand/mdpage/workflows/build/badge.svg?style=flat-square)](https://github.com/bojand/mdpage/actions?workflow=build)\n[![LICENSE](https://img.shields.io/github/license/bojand/mdpage.svg?style=flat-square)](LICENSE)\n[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg?style=flat-square)](https://www.paypal.me/bojandj)\n[![Buy me a coffee](https://img.shields.io/badge/buy%20me-a%20coffee-orange.svg?style=flat-square)](https://www.buymeacoffee.com/bojand)\n\n[mdPage](https://github.com/bojand/mdpage) is a minimal, opinionated, command line utility (and [Rust](https://www.rust-lang.org/) crate) for creating single-page HTML documentation from markdown files.\n\n## Demo\n\nThe [mdPage documentation](https://bojand.github.io/mdpage) is generated using the `mdpage` CLI tool from markdown source files. There are additional examples listed in the documentation with sources available in the `docs` directory.\n\n## Installation\n\nThere are multiple ways to install mdPage.\n\n1. **Binaries**\n\n   Binaries are available for download [here](https://github.com/bojand/mdpage/releases). Make sure to put the\n   path to the binary into your `PATH`.\n\n2. **From Crates.io**\n\n   This requires Rust and Cargo to be installed. Once you have installed\n   Rust, type the following in the terminal:\n\n   ```\n   cargo install mdpage\n   ```\n\n   This will download and compile mdPage for you, the only thing left to do is\n   to add the Cargo bin directory to your `PATH`.\n\n## Usage\n\n`mdpage` tool takes a singe argument, the root path directory where all the markdown content is located.\n\n```sh\n$ mdpage --help\nmdpage 0.1.1\nGenerate simple documentation\n\nUSAGE:\n    mdpage [FLAGS] [OPTIONS] \u003cpath\u003e\n\nFLAGS:\n        --full-page    Generate full page documentation\n    -h, --help         Prints help information\n    -V, --version      Prints version information\n\nOPTIONS:\n    -o, --output \u003coutput\u003e        The output file\n        --subtitle \u003csubtitle\u003e    Subtitle of the document\n        --title \u003ctitle\u003e          Title of the document\n\nARGS:\n    \u003cpath\u003e    Path for the directory containing data\n```\n\nThe result of running the tool is always an `index.html` file.\n\nExample workflow:\n\n```sh\n$ ls ./examples/basic | sort\npage1.md\npage2.md\nreadme.md\n\n$ mdpage ./examples/basic\n\n$ ls ./examples/basic | sort\nindex.html\npage1.md\npage2.md\nreadme.md\n\n$ open index.html\n```\n\n## License\n\nApache-2.0","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbojand%2Fmdpage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbojand%2Fmdpage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbojand%2Fmdpage/lists"}