{"id":18764481,"url":"https://github.com/modernweb-dev/check-html-links-action","last_synced_at":"2025-04-13T04:33:35.697Z","repository":{"id":65160950,"uuid":"331371954","full_name":"modernweb-dev/check-html-links-action","owner":"modernweb-dev","description":"This action checks whether there are any dead links in the documentation of your repository. Based on check-html-links from Modern Web.","archived":false,"fork":false,"pushed_at":"2021-01-22T09:16:11.000Z","size":6,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-09T15:58:17.456Z","etag":null,"topics":["ci","documentation","github-actions","github-pages","hugo","jekyll"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/check-html-links-action","language":"Shell","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/modernweb-dev.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}},"created_at":"2021-01-20T16:55:32.000Z","updated_at":"2024-05-17T16:51:34.000Z","dependencies_parsed_at":"2023-01-12T14:31:22.759Z","dependency_job_id":null,"html_url":"https://github.com/modernweb-dev/check-html-links-action","commit_stats":{"total_commits":8,"total_committers":1,"mean_commits":8.0,"dds":0.0,"last_synced_commit":"14e22a7f2fc723cdcf7078ae10c92b1034ff04d3"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modernweb-dev%2Fcheck-html-links-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modernweb-dev%2Fcheck-html-links-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modernweb-dev%2Fcheck-html-links-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modernweb-dev%2Fcheck-html-links-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/modernweb-dev","download_url":"https://codeload.github.com/modernweb-dev/check-html-links-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248664724,"owners_count":21142018,"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":["ci","documentation","github-actions","github-pages","hugo","jekyll"],"created_at":"2024-11-07T18:30:01.064Z","updated_at":"2025-04-13T04:33:35.464Z","avatar_url":"https://github.com/modernweb-dev.png","language":"Shell","readme":"# [Check HTML Links Github Action](https://github.com/modernweb-dev/check-html-links-action)\n\n\nThis action checks whether there are any dead links in the documentation of your repository. Based on [check-html-links](https://www.npmjs.com/package/check-html-links) from [Modern Web](https://modern-web.dev/). \n\nThis action will run in a folder with html and js files. In other words, that comes **after** your Jekyll, Yarn, or any other compilation step.\n\n*Note: Does not test external links, only internal ones :).*\n\n**Latest version : V1**\n\n## Inputs\n\n### `doc-folder`\n\n**Optional** The location of the documentation folder. Default `\"dist\"`.\n\n## Outputs\n\n### `result`\n\nThe complete console output of the folder\n\n## Example usage\n\nSnippet \n\n```YAML\nuses: modernweb-dev/check-html-links-action@v1\nwith:\n  doc-folder: '_site'\n```\n\nHere is a complete Example workflow that will check the result of the folder `_dist` in the root of your repository on each push: \n\n```YAML\non: [push]\n\njobs:\n  check_html_links_job:\n    runs-on: ubuntu-latest\n    name: A job to test check-html-links-action\n    steps:\n    - uses: actions/checkout@v2\n    - name: check-html-links-action step\n      id: check-links\n      uses: modernweb-dev/check-html-links-action@v1\n      with:\n        doc-folder: 'test-site'\n```\n\n\n# Tests\n\nSee test repository and latest status [here](https://github.com/modernweb-dev/check-html-links-action-test/actions).\n\n# LICENSE\n\n[MIT](https://tldrlegal.com/license/mit-license)\n\n# Author\n\n[Modern Web](https://modern-web.dev)","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmodernweb-dev%2Fcheck-html-links-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmodernweb-dev%2Fcheck-html-links-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmodernweb-dev%2Fcheck-html-links-action/lists"}