https://github.com/tmaier/docker-markdown-spellcheck

A spell checker for Markdown files. Ready for CI with Docker
https://github.com/tmaier/docker-markdown-spellcheck

Last synced: about 1 month ago
JSON representation

A spell checker for Markdown files. Ready for CI with Docker

• Host: GitHub
• URL: https://github.com/tmaier/docker-markdown-spellcheck
• Owner: tmaier
• License: mit
• Created: 2016-12-17T14:05:19.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-10-24T23:16:21.000Z (about 4 years ago)
• Last Synced: 2024-10-11T18:15:30.427Z (2 months ago)
• Language: Dockerfile
• Homepage: https://hub.docker.com/r/tmaier/markdown-spellcheck/
• Size: 5.86 KB
• Stars: 3
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Docker image for node-markdown-spellcheck

This is a lightweight docker image for [`node-markdown-spellcheck`](https://github.com/lukeapage/node-markdown-spellcheck).

A spell checker for Markdown files.

See https://github.com/lukeapage/node-markdown-spellcheck

The working directory is at `/workdir`. Mount your volume into that directory.

```bash

$ docker run --rm -ti -v $(pwd):/workdir tmaier/markdown-spellcheck:latest "**/*.md"

```

## Other languages

Many additional directories can be found at `/usr/share/hunspell`.

List all languages available:

```bash

$ docker run --rm -ti tmaier/markdown-spellcheck:latest hunspell -D

```

```bash

$ docker run --rm -ti -v $(pwd):/workdir tmaier/markdown-spellcheck:latest --dictionary /usr/share/hunspell/de_DE_comb "**/*.md"

```

## Continuous Integration (CI)

Run in report mode

```bash

$ docker run --rm -ti -v $(pwd):/workdir tmaier/markdown-spellcheck:latest --report "**/*.md"

```

## Author

[Tobias L. Maier](https://tobiasmaier.info) for [BauCloud GmbH](https://www.baucloud.com)