{"id":27694992,"url":"https://github.com/volubyl/markdown-proofreader","last_synced_at":"2026-04-19T15:05:21.926Z","repository":{"id":42858445,"uuid":"259975627","full_name":"Volubyl/markdown-proofreader","owner":"Volubyl","description":null,"archived":false,"fork":false,"pushed_at":"2023-01-06T04:40:16.000Z","size":447,"stargazers_count":1,"open_issues_count":12,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-08-01T18:28:56.297Z","etag":null,"topics":["bad-english","markdown","proofreading"],"latest_commit_sha":null,"homepage":null,"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/Volubyl.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":"2020-04-29T16:09:59.000Z","updated_at":"2024-02-05T11:19:00.000Z","dependencies_parsed_at":"2023-02-05T08:31:40.996Z","dependency_job_id":null,"html_url":"https://github.com/Volubyl/markdown-proofreader","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/Volubyl/markdown-proofreader","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Volubyl%2Fmarkdown-proofreader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Volubyl%2Fmarkdown-proofreader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Volubyl%2Fmarkdown-proofreader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Volubyl%2Fmarkdown-proofreader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Volubyl","download_url":"https://codeload.github.com/Volubyl/markdown-proofreader/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Volubyl%2Fmarkdown-proofreader/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32010960,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T20:23:30.271Z","status":"online","status_checked_at":"2026-04-19T02:00:07.110Z","response_time":55,"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":["bad-english","markdown","proofreading"],"created_at":"2025-04-25T14:14:18.865Z","updated_at":"2026-04-19T15:05:21.893Z","avatar_url":"https://github.com/Volubyl.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Markdown Proofreader\n\n## Motivation\n\nBecause during the COVID-19 quarantine I wrote tons of Markdown files (such as README.md). Mostly in bad english...\nI was looking for a simple solution to check the syntax and grammar of those notes.\n\n## Technologies\n\n`markdown-proofreader` is built :\n\n- on top of [Grammar Bot API](https://www.grammarbot.io/) for proofreading purpose \n- with [Highland.js](https://highlandjs.org/) for handling streams\n- with [fast-glob](https://github.com/mrmlnc/fast-glob) to match only markdown files\n- with eslint/prettier combo AirBnB flavor \n\n## Installation\n\n**Warning** :\n- Markdown Proofreader requires you use `git` as version control software.\n\nRun `npm install markdown-proofreader`.\n\n## How to use ?\n\n`Markdown Proofreader` has currently two modes \n\n- Verification of files matching a glob\n- Verification of additions compared to the last commit (diff mode)\n\n### Files matching a glob (Default mode)\n\nBy default, Markdown proofreader will check all markdown files present in the repository.\n\nUse `--match` flag to target specific files using a glob pattern.\n\nUnder the hood we are using `Fast Glob` to find pathnames that matched a provided pattern.\n\nSee [`fast-glob` documentation](https://github.com/mrmlnc/fast-glob) to learn more about the syntax.\n\n### Diff mode\n\n#### Working with new files\n\n1. Write your next best-seller essai or the documentation of your anti COVID-19 software in plain Markdown\n2. Track the changes (`git add`)\n3. Run `markdown-proofreader --diff-only`\n4. Get your report\n\n#### Working with updated files\n\n1. Update your files\n2. Track the changes (`git add`)\n3. Run `markdown-proofreader --diff-only`\n4. Get your report\n\n(only the updates will be considered, not the deletion)\n\n#### How does it work ?\n\n`markdown-proofreader` will perfom a `git diff --cached` on your markdown files, strip the markdown and send the content to GrammarBot API.\n\n\n## CLI options\n\n- `--diff-only` : used to work in 'only-diff mode'  {optional}\n- `--match` : used to provide a glob pattern to target only specific file (optional)\n\n\n## FAQ\n\n### Do you work for GrammarBot ?\n\nNope. I'm not working for GrammarBot or get any money/goodies/support from them. I just did some research on DuckDuckGo and found that API. I will try to integrate other APIs in a future release.\n\n### You don't like human proofreader ?\nYes I really do. But unfortunately, I'm still too broke to hire a reviewer for every text I write. But yes, please hire **REAL HUMANS**.\n\n### I found mistakes in this README ...\n\nOne point for hiring real humans ...\n\n## How to contribute ?\n\n`markdown-proofreader` is a baby project in its early stage. Few bugs lies certainly in the shadow and many functionalities are certainly missing.\n\nFeel free to open an issue or a PR\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvolubyl%2Fmarkdown-proofreader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvolubyl%2Fmarkdown-proofreader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvolubyl%2Fmarkdown-proofreader/lists"}