https://github.com/volubyl/markdown-proofreader
https://github.com/volubyl/markdown-proofreader
bad-english markdown proofreading
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/volubyl/markdown-proofreader
- Owner: Volubyl
- License: mit
- Created: 2020-04-29T16:09:59.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T04:40:16.000Z (over 3 years ago)
- Last Synced: 2025-08-01T18:28:56.297Z (11 months ago)
- Topics: bad-english, markdown, proofreading
- Language: JavaScript
- Size: 437 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Markdown Proofreader
## Motivation
Because during the COVID-19 quarantine I wrote tons of Markdown files (such as README.md). Mostly in bad english...
I was looking for a simple solution to check the syntax and grammar of those notes.
## Technologies
`markdown-proofreader` is built :
- on top of [Grammar Bot API](https://www.grammarbot.io/) for proofreading purpose
- with [Highland.js](https://highlandjs.org/) for handling streams
- with [fast-glob](https://github.com/mrmlnc/fast-glob) to match only markdown files
- with eslint/prettier combo AirBnB flavor
## Installation
**Warning** :
- Markdown Proofreader requires you use `git` as version control software.
Run `npm install markdown-proofreader`.
## How to use ?
`Markdown Proofreader` has currently two modes
- Verification of files matching a glob
- Verification of additions compared to the last commit (diff mode)
### Files matching a glob (Default mode)
By default, Markdown proofreader will check all markdown files present in the repository.
Use `--match` flag to target specific files using a glob pattern.
Under the hood we are using `Fast Glob` to find pathnames that matched a provided pattern.
See [`fast-glob` documentation](https://github.com/mrmlnc/fast-glob) to learn more about the syntax.
### Diff mode
#### Working with new files
1. Write your next best-seller essai or the documentation of your anti COVID-19 software in plain Markdown
2. Track the changes (`git add`)
3. Run `markdown-proofreader --diff-only`
4. Get your report
#### Working with updated files
1. Update your files
2. Track the changes (`git add`)
3. Run `markdown-proofreader --diff-only`
4. Get your report
(only the updates will be considered, not the deletion)
#### How does it work ?
`markdown-proofreader` will perfom a `git diff --cached` on your markdown files, strip the markdown and send the content to GrammarBot API.
## CLI options
- `--diff-only` : used to work in 'only-diff mode' {optional}
- `--match` : used to provide a glob pattern to target only specific file (optional)
## FAQ
### Do you work for GrammarBot ?
Nope. 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.
### You don't like human proofreader ?
Yes 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**.
### I found mistakes in this README ...
One point for hiring real humans ...
## How to contribute ?
`markdown-proofreader` is a baby project in its early stage. Few bugs lies certainly in the shadow and many functionalities are certainly missing.
Feel free to open an issue or a PR