{"id":48039666,"url":"https://github.com/flowcommerce/readme-sync","last_synced_at":"2026-04-04T14:05:55.222Z","repository":{"id":36784428,"uuid":"229839854","full_name":"flowcommerce/readme-sync","owner":"flowcommerce","description":"Sync markdown files to readme.com","archived":false,"fork":false,"pushed_at":"2024-12-09T17:52:19.000Z","size":267,"stargazers_count":12,"open_issues_count":3,"forks_count":4,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-08-30T12:47:18.295Z","etag":null,"topics":["cli","docs","markdown","readme","sync"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/flowcommerce.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":"2019-12-24T00:00:11.000Z","updated_at":"2024-12-09T17:52:20.000Z","dependencies_parsed_at":"2024-12-09T18:33:00.015Z","dependency_job_id":"bd5a541e-34b0-4a2e-b8e3-366d0ecf2675","html_url":"https://github.com/flowcommerce/readme-sync","commit_stats":{"total_commits":107,"total_committers":4,"mean_commits":26.75,"dds":"0.14018691588785048","last_synced_commit":"528e6f2cab4aa0e1ca5719decf88493405733020"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/flowcommerce/readme-sync","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flowcommerce%2Freadme-sync","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flowcommerce%2Freadme-sync/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flowcommerce%2Freadme-sync/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flowcommerce%2Freadme-sync/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flowcommerce","download_url":"https://codeload.github.com/flowcommerce/readme-sync/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flowcommerce%2Freadme-sync/sbom","scorecard":{"id":404308,"data":{"date":"2025-08-11","repo":{"name":"github.com/flowcommerce/readme-sync","commit":"5d9fcd93164875b897c038743a2fca46bd8f14c4"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.7,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"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":"Code-Review","score":1,"reason":"Found 2/14 approved changesets -- score normalized to 1","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":"Dangerous-Workflow","score":-1,"reason":"no workflows found","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":"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":"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":"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: 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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"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":"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":"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":"Branch-Protection","score":6,"reason":"branch protection is not maximal on development and all release branches","details":["Info: 'allow deletion' disabled on branch 'main'","Info: 'force pushes' disabled on branch 'main'","Info: 'branch protection settings apply to administrators' is required to merge on branch 'main'","Info: 'stale review dismissal' is required to merge on branch 'main'","Warn: required approving review count is 1 on branch 'main'","Warn: codeowners review is not required on branch 'main'","Info: 'last push approval' is required to merge on branch 'main'","Warn: no status checks found to merge onto branch 'main'","Info: PRs are required in order to make changes on 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":"Vulnerabilities","score":0,"reason":"10 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 22 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"}}]},"last_synced_at":"2025-08-18T20:49:55.145Z","repository_id":36784428,"created_at":"2025-08-18T20:49:55.145Z","updated_at":"2025-08-18T20:49:55.145Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31402277,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-04T10:20:44.708Z","status":"ssl_error","status_checked_at":"2026-04-04T10:20:06.846Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["cli","docs","markdown","readme","sync"],"created_at":"2026-04-04T14:05:54.482Z","updated_at":"2026-04-04T14:05:55.203Z","avatar_url":"https://github.com/flowcommerce.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# readme.com Sync Tool\n\nThis is a CLI tool that synchronizes markdown files from a local directory (typically in a git repo) to https://readme.com.\n\n## Usage\n\n`npx readme-sync --apiKey \u003ckey\u003e --version \u003cversion\u003e --docs \u003cdir\u003e`\n\nor, to just validate the files:\n\n`npx readme-sync --apiKey \u003ckey\u003e --version \u003cversion\u003e --docs \u003cdir\u003e --validateOnly`\n\n## Expected Directory Structure\n\nTop level folders are mapped to categories. Second and third level `.md` files are synced as docs. Readme only supports two levels of nesting (Category \u003e Parent Doc \u003e Child Doc). If you want a doc with children, create a folder with the doc name, and create an `index.md` file inside it.\n\nThe folder and file names are turned into the slugs.\n\nExample:\n\n```\ndocs\n├── Welcome\n│   ├── 00-introduction.md\n│   └── 10-license.md\n└── Integration\n    ├── 00-installation.md\n    ├── 10-setup.md\n    └── 20-configuration\n        ├── index.md\n        ├── 00-database.md\n        └── 10-proxy.md\n```\n\nBecomes\n\n![](result.png)\n\n## File Contents\n\nMarkdown, with front matter:\n\n```markdown\n---\ntitle: \"Installation\"\nexcerpt: \"How to Install Arch Linux\" # optional\nhidden: true # optional\n---\n\n# Installation\n\n...\n```\n\n## Limitations\n\n- Categories cannot yet be created automatically. They must be manually created in Readme. You can fetch the existing category slugs with\n```bash\ncurl 'https://dash.readme.io/api/v1/categories?perPage=100' -u '\u003cyour_readme_api_key\u003e': -H 'x-readme-version: \u003cyour_docs_version\u003e'\n```\nNote that category slugs may differ from the category titles you see on dash.readme.io, so this API call is a good way to troubleshoot the error message \"can't create categories.\"\n\n## Syncing Behavior\n\n- If you have a category on readme.com that you don't have locally, the category and its contents will remain untouched on readme.com.\n- If you have a doc on readme.com that you don't have locally (but you have the category), it will be deleted from readme.com.\n- If you have a doc locally that is not on readme.com, it will be uploaded to readme.com\n- If you try to create two docs with the same name, you'll get an error about document slugs not being unique, even if the files are in separate categories.\n- The publishing order is alphanumeric. You can force ordering by prefixing your files with `01-`, `02-`, etc. Then, these ordered pages go first in the table of contents (stripped of their `01-`, `02-` ordering prefixes).\n\n## Development\n\n1. `git clone https://github.com/flowcommerce/readme-sync`\n1. `nvm install`\n1. `npm install`\n1. `npx ts-node sync/index.ts --apiKey \u003ckey\u003e --version \u003cversion\u003e --docs \u003cdir\u003e`\n\n## Releasing a new version\n\n```bash\n$ npm version patch\n$ npm publish\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflowcommerce%2Freadme-sync","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflowcommerce%2Freadme-sync","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflowcommerce%2Freadme-sync/lists"}