{"id":20380477,"url":"https://github.com/tobua/docy","last_synced_at":"2026-05-01T21:03:47.422Z","repository":{"id":57214395,"uuid":"141908899","full_name":"tobua/docy","owner":"tobua","description":" Documentation generator for your plugin, library or framework.","archived":false,"fork":false,"pushed_at":"2021-06-06T21:38:58.000Z","size":111,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-30T18:43:41.641Z","etag":null,"topics":["documentation","markdown"],"latest_commit_sha":null,"homepage":"https://tobua.github.io/docy","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tobua.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-22T15:46:44.000Z","updated_at":"2021-06-06T21:41:52.000Z","dependencies_parsed_at":"2022-08-26T13:41:38.849Z","dependency_job_id":null,"html_url":"https://github.com/tobua/docy","commit_stats":null,"previous_names":["naminho/docy"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tobua/docy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tobua%2Fdocy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tobua%2Fdocy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tobua%2Fdocy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tobua%2Fdocy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tobua","download_url":"https://codeload.github.com/tobua/docy/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tobua%2Fdocy/sbom","scorecard":{"id":890981,"data":{"date":"2025-08-11","repo":{"name":"github.com/tobua/docy","commit":"6eba3d9f3e002ac8c995a7359a3d7a81b05c4b46"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.1,"checks":[{"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":"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":"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":"Code-Review","score":0,"reason":"Found 0/16 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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/demo.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":"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":"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/demo.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/tobua/docy/demo.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/demo.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/tobua/docy/demo.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/demo.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/tobua/docy/demo.yml/master?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/demo.yml:18","Warn: npmCommand not pinned by hash: .github/workflows/demo.yml:19","Warn: npmCommand not pinned by hash: .github/workflows/demo.yml:21","Warn: npmCommand not pinned by hash: .github/workflows/demo.yml:23","Warn: npmCommand not pinned by hash: .github/workflows/demo.yml:25","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   5 npmCommand 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":"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":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"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":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"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"}}]},"last_synced_at":"2025-08-24T11:49:32.635Z","repository_id":57214395,"created_at":"2025-08-24T11:49:32.636Z","updated_at":"2025-08-24T11:49:32.636Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32512670,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"online","status_checked_at":"2026-05-01T02:00:05.856Z","response_time":64,"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","markdown"],"created_at":"2024-11-15T02:07:26.393Z","updated_at":"2026-05-01T21:03:47.394Z","avatar_url":"https://github.com/tobua.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/tobua/docy/raw/master/logo.png\" alt=\"docy\" height=\"300\"\u003e\n\u003c/p\u003e\n\n# docy\n\nDocumentation generator for your plugin, library or framework.\n\n## Quick Start from Template\n\n```\n# In current folder\nnpm init now docy\n# Specific folder\nnpm init now docy my-documentation\n```\n\n## One-time Installation\n\nThe get started quickly create one or more Markdown `.md` files and inside that\nfolder run the following from the console having [node](http://nodejs.org) installed:\n\n```\nnpx -y docy\n```\n\nYou'll be asked whether you want open the result in the browser and watch for changes.\n\n## Regular Installation\n\nTo get started set up a `package.json` in the folder where you want to keep the documentation.\n\n```json\n{\n  \"name\": \"my-documentation\",\n  \"scripts\": {\n    \"start\": \"docy\",\n    \"develop\": \"docy --watch --open\",\n    \"build\": \"docy --build\"\n  }\n}\n```\n\nIf you already have a `package.json` add the script that matches your needs best.\n\nFirst install `docy` by running `npm install docy` and then generate the documentation running `npm start`.\n\n## Structure\n\nThe documentation is stored inside markdown files.\n\n`Simple`\n\n```\ndocy\n├── 1-intro.md\n├── 2-installation.md\n├── 3-usage.md\n└── 4-license.md\n```\n\nFiles inside a folder will be ordered alphabetically, to avoid this and keep\nthe desired order add numbers in front. The filename will only be used for the\npurpose of ordering the contents.\n\n`Groups`\n\n```\ndocy\n├── 1-introduction\n│   ├── 1-welcome.md\n│   └── 2-intro.md\n├── 2-installation\n|   ├── 1-regular.md\n│   └── 2-global.md\n├── 3-usage.md\n└── 4-license.md\n```\n\nFor more complex documentations the files can be nested inside folders to\nrepresent different levels.\n\n## Contents\n\nHere's how an example `.md` file could look like:\n\n```\n# Installation\n\nto install run `npm i docy`.\n```\n\n## Usage\n\n### Options\n\nThe plugin can be configured by setting options in the `package.json` file.\n\n```json\n{\n  \"name\": \"my-documentation\",\n  \"scripts\": {\n    \"start\": \"docy\"\n  },\n  \"docy\": {\n    \"title\": \"My Documentation\"\n  }\n}\n```\n\nThe following options are available:\n\n`title` default `package.name`\n\nSet the title of the documentation.\n\n`footer` default `empty`\n\nSet the footer content.\n\n`result` default `index.html`\n\nName of the resulting documentation file.\n\n`dist` default `./dist`\n\nFolder where the generated documentation should be placed.\n\n`single` default `true`\n\nGenerate a single HTML file for the whole documentation. Set to `false` to generate a separate HTML file for every source file. Currently this will only generate separate files for the top level.\n\n`template` default `template.html`\n\nPath relative to the documentation directory pointing to an `ejs` template.\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftobua%2Fdocy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftobua%2Fdocy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftobua%2Fdocy/lists"}