{"id":18282977,"url":"https://github.com/zentered/markdown-seo-check","last_synced_at":"2025-04-05T06:30:51.041Z","repository":{"id":39286688,"uuid":"344744093","full_name":"zentered/markdown-seo-check","owner":"zentered","description":"GitHub Action to validate markdown files with SEO best practices. Creates a pull request comment and fails if conditions are not met.","archived":false,"fork":false,"pushed_at":"2024-09-04T20:39:09.000Z","size":1270,"stargazers_count":8,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-02T23:05:58.727Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/zentered.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2021-03-05T08:28:19.000Z","updated_at":"2025-04-02T22:26:23.000Z","dependencies_parsed_at":"2022-09-04T07:23:08.645Z","dependency_job_id":"bddd8039-babb-4c5c-8881-4537af2bc108","html_url":"https://github.com/zentered/markdown-seo-check","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zentered%2Fmarkdown-seo-check","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zentered%2Fmarkdown-seo-check/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zentered%2Fmarkdown-seo-check/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zentered%2Fmarkdown-seo-check/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zentered","download_url":"https://codeload.github.com/zentered/markdown-seo-check/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246905838,"owners_count":20852818,"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":[],"created_at":"2024-11-05T13:06:53.261Z","updated_at":"2025-04-05T06:30:49.754Z","avatar_url":"https://github.com/zentered.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Markdown SEO Check\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"res/markdowncheck.png\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/zentered/markdown-seo-check/actions/workflows/seocheck.yml\"\u003e\u003cimg alt=\"Workflow Integration Test status\" src=\"https://github.com/zentered/markdown-seo-check/actions/workflows/seocheck.yml/badge.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/zentered/markdown-seo-check/actions/workflows/test.yml\"\u003e\u003cimg alt=\"Unit Test status\" src=\"https://github.com/zentered/markdown-seo-check/actions/workflows/test.yml/badge.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/zentered/markdown-seo-check/actions/workflows/publish.yml\"\u003e\u003cimg alt=\"Unit Test status\" src=\"https://github.com/zentered/markdown-seo-check/actions/workflows/publish.yml/badge.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://semantic-release.gitbook.io/semantic-release/\"\u003e\u003cimg alt=\"Semantic Release bagde\" src=\"https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://zentered.co\"\u003e\u003cimg alt=\"Semantic Release bagde\" src=\"https://img.shields.io/badge/\u003e-Zentered-lightgrey?style=flat\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nValidate markdown files with SEO best practices. Creates a pull request comment\nand fails if conditions are not met.\n\n## Table of Contents\n\n- [Usage](#usage)\n- [Inputs](#inputs)\n- [Outputs](#outputs)\n\n## Usage\n\nIf your repo is public and you have pull requests from forks,\n`pull_request_target` is required, as this Action creates a comment on a Pull\nRequest and therefore requires read/write permissions. Read more about the\n`pull_request_target` trigger\n[here](https://securitylab.github.com/research/github-actions-preventing-pwn-requests).\nIf your repo is private, you can change this to `pull_request` and remove the\n`ref` in the checkout action.\n\n```yaml\nname: check\n\non: pull_request_target\n\njobs:\n  seocheck:\n    name: Markdown SEO Check\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v2\n        with:\n          ref: ${{ github.event.pull_request.head.sha }}\n      - name: Markdown SEO Check\n        uses: zentered/markdown-seo-check@v1.1.0\n        with:\n          max_title_length: 70\n          max_description_length: 150\n          max_slug_length: 100\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\n## Inputs\n\n| Name                     | Requirement | Default        | Description                                                                                                                             |\n| ------------------------ | ----------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `includes`               | optional    | `{*.md,*.mdx}` | Glob to include specific files or folders. See [glob-to-regexp usage](https://www.npmjs.com/package/glob-to-regexp#usage) for examples. |\n| `excludes`               | optional    | ''             | Glob to exclude files or folders                                                                                                        |\n| `max_title_length`       | required    | 70             | Maximum length of page title                                                                                                            |\n| `max_description_length` | required    | 150            | Maximum length of description                                                                                                           |\n| `max_slug_length`        | required    | 100            | Maximum length of slug                                                                                                                  |\n\n## Outputs\n\n![screenshot of github comment](res/output.png)\n\n## Contributing\n\nSee [CONTRIBUTING](CONTRIBUTING.md).\n\n## License\n\nSee [LICENSE](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzentered%2Fmarkdown-seo-check","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzentered%2Fmarkdown-seo-check","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzentered%2Fmarkdown-seo-check/lists"}