{"id":15379930,"url":"https://github.com/iansan5653/github-markdown-a11y-extension","last_synced_at":"2025-04-14T21:51:41.190Z","repository":{"id":155109012,"uuid":"630654552","full_name":"iansan5653/github-markdown-a11y-extension","owner":"iansan5653","description":":accessibility: Check your Markdown for accessibility issues as you write it on GitHub","archived":false,"fork":false,"pushed_at":"2025-01-20T09:16:42.000Z","size":2440,"stargazers_count":28,"open_issues_count":3,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-28T09:51:37.356Z","etag":null,"topics":["accessibility","browser-extension","chrome-extension","edge-extension","firefox-addon","github","markdown"],"latest_commit_sha":null,"homepage":"https://github.com/iansan5653/github-markdown-a11y-extension?tab=readme-ov-file#installation","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/iansan5653.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license.md","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":"2023-04-20T21:16:59.000Z","updated_at":"2025-02-11T16:28:48.000Z","dependencies_parsed_at":"2024-02-23T20:30:59.828Z","dependency_job_id":"d84465f1-db8c-43e4-8d16-552a045d808b","html_url":"https://github.com/iansan5653/github-markdown-a11y-extension","commit_stats":{"total_commits":144,"total_committers":4,"mean_commits":36.0,"dds":"0.45138888888888884","last_synced_commit":"d9ded2dd837ae4eaa3f70e748a75a708b6417775"},"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iansan5653%2Fgithub-markdown-a11y-extension","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iansan5653%2Fgithub-markdown-a11y-extension/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iansan5653%2Fgithub-markdown-a11y-extension/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iansan5653%2Fgithub-markdown-a11y-extension/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iansan5653","download_url":"https://codeload.github.com/iansan5653/github-markdown-a11y-extension/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248968741,"owners_count":21191158,"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":["accessibility","browser-extension","chrome-extension","edge-extension","firefox-addon","github","markdown"],"created_at":"2024-10-01T14:20:26.706Z","updated_at":"2025-04-14T21:51:41.139Z","avatar_url":"https://github.com/iansan5653.png","language":"TypeScript","readme":"\u003cdiv align=\"center\"\u003e\u003cimg src=\"assets/promo.png\" alt=\"Markdown Accessibility Checker app icon; a letter A on a blue background with a subtle down-pointing arrow as a shadow, looking dramatic like a superhero logo.\" /\u003e\u003c/div\u003e\n\n## Markdown Accessibility Checker\n\nMarkdown Accessibility Checker is a browser extension for validating Markdown in GitHub text editors. It encourages writing accessible valid Markdown when creating issues, pull requests, discussions, and comments.\n\n\u003cimg alt=\"Issue creation form on github.com with two lint errors visible. One is hovered over, showing a tooltip that says 'heading levels should only increment by one level at a time'\" src=\"./assets/screenshot.png\" width=\"1000\" /\u003e\n\n### Installation\n\nInstall from your browser's addons store:\n\n- [Chrome or Edge](https://chrome.google.com/webstore/detail/accessibility-checker-for/hdonjoppcjfaojggdiliigclajklepdg)\n- [Firefox](https://addons.mozilla.org/en-US/firefox/addon/a11y-checker-github-md/)\n\nAlternatively, you can install a specific version by downloading the corresponding `zip` file from the [Releases](https://github.com/iansan5653/github-markdown-a11y-extension/releases) page.\n\n### Linting rules used\n\nUnder the hood, the extension is a wrapper around [Markdownlint](https://github.com/markdownlint/markdownlint), providing a web-compatible UI for viewing linting errors. The base set of rules comes from [markdownlint-github](https://github.com/github/markdownlint-github). In addition, a few more rules are enabled:\n\n- `no-reversed-links`: Enforces valid link syntax (errors if you accidentally flip the square brackets and parentheses)\n- `no-empty-links`: Ensures all links have some visible link text\n\nFor now, the set of linting rules is not configurable. In order to minimize friction and distractions, only a small subset of lint rules are enabled. The extension does not try to encourage any sort of style or formatting - it's only here to help you with accessibility and syntax.\n\n\u003e **Note**: Requests for new rules and changes to existing rules should be made in either the Markdownlint or Markdownlint-github repositories, not here.\n\n### Development\n\nTo run the extension locally and automatically reload when making changes, follow these steps.\n\n\u003e **Note**: The version number is always `0.0.0` when working locally.\n\n#### Preparation\n\n1. Developing this extension requires [Node and npm](https://nodejs.org/en) to be installed on your machine\n2. Remove any existing installations of the extension\n3. Run `npm install` to install dependencies\n4. Run `npm run build:watch` to compile the TypeScript code into JavaScript:\n    ```text\n    \u003e npm run build:watch\n    ...\n    Accessibility_Checker_for_GitHub_Markdown (webpack 5.80.0) compiled with 1 warning in 41 ms\n    ```\n    Leave this running in the background as you make changes.\n\n#### Testing in Chrome\n\nThe easiest way to test this extension locally in Chrome is to [install it unpacked](https://developer.chrome.com/docs/extensions/mv3/getstarted/development-basics/#load-unpacked). When you make changes to the TypeScript code, you must press the \"refresh\" button on the extension card in chrome://extensions to see your changes.\n\n#### Testing in Firefox\n\nFirefox has a CLI that will automatically reload the extension on changes, making it slightly easier to develop using Firefox:\n\nRun `npm run start:firefox` to use [`web-ext run`](https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#web-ext-run) to run the extension in Firefox. By default this will create a new temporary test profile. If you want to use your profile, you can provide a profile to the CLI by passing the `--firefox-profile` argument like so: `npm run start:firefox -- --firefox-profile=my-profile`.\n\n```text\n\u003e npm run start:firefox\n...\nInstalled /.../markdownlint-browser as a temporary add-on\nThe extension will reload if any source file changes\nPress R to reload (and Ctrl-C to quit)\n```\n\n#### Checking for Problems\n\nTo run the automated checks to look for potential issues in the code, run the combined `check` script. There are a few warnings that are known and unavoidable due to dependencies, but this script should not exit with an error code.\n\n```text\n\u003e npm run check\n...\nChecking formatting...\nAll matched files use Prettier code style!\n...\nWARNING in ./node_modules/markdownlint/lib/markdownlint.js 16:74-81\n  Critical dependency: require function is used in a way in which dependencies cannot be statically extracted\n   @ ./src/utilities/lint-markdown.ts 1:0-40 3:40-57\n   @ ./src/components/linted-markdown-editor.ts 7:0-58 120:19-31\n   @ ./src/content-script.ts 5:0-75 16:27-47\n\n  Accessibility_Checker_for_GitHub_Markdown (webpack 5.80.0) compiled with 1 warning in 517 ms\n...\nWARNINGS:\n\nDANGEROUS_EVAL ...\nUNSAFE_VAR_ASSIGNMENT ...\nDANGEROUS_EVAL ...\n```\n\n#### Build Instructions\n\nFollow these instructions to build this extension from source, creating an installable and shareable `zip` file:\n\n1. Building this extension requires [Node and npm](https://nodejs.org/en) to be installed on your machine\n2. Run `npm install` to install dependencies\n3. Run `npm run package` to package the built code into `./web-ext-artifacts/accessibility_checker_for_github_markdown-0.0.0.zip`\n\n#### Release process\n\nReleases are automatically handled by [an Actions job](https://github.com/iansan5653/github-markdown-a11y-extension/actions/workflows/release.yml) after a new GitHub [Release](https://github.com/iansan5653/github-markdown-a11y-extension/releases) is published.\n\n\u003e **Warning**: Release tag names **must** follow the `0.0.0` version number format (with no leading `v`).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiansan5653%2Fgithub-markdown-a11y-extension","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiansan5653%2Fgithub-markdown-a11y-extension","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiansan5653%2Fgithub-markdown-a11y-extension/lists"}