https://github.com/vshn/hunspell
Docker image used to spell check the contents of documents produced at VSHN.
https://github.com/vshn/hunspell
Last synced: 2 months ago
JSON representation
Docker image used to spell check the contents of documents produced at VSHN.
- Host: GitHub
- URL: https://github.com/vshn/hunspell
- Owner: vshn
- Created: 2020-05-19T11:38:30.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-28T11:21:11.000Z (about 2 years ago)
- Last Synced: 2025-01-29T01:46:28.581Z (4 months ago)
- Language: Dockerfile
- Homepage:
- Size: 11.7 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.adoc
Awesome Lists containing this project
README
= Hunspell for VSHN
This project builds a container image encapsulating https://hunspell.github.io/[hunspell], to spell check the contents of documents produced at VSHN.
== Exceptions
The file `hunspell_exclude` contains a list of words that are acceptable within VSHN documentation, including the following:
* Network protocols.
* Names of common products.
* Various acronyms.
== Dictionaries
The version of `hunspell` provided in this image _only_ contains dictionaries for the following languages:
* English
* German
* French
NOTE: You can check the list of available dictionaries using the command `podman run --rm --volume $(pwd):/spell ghcr.io/vshn/hunspell:1.7.0.2 -D`
== Usage
For example, after building an Antora website with the `make html` command, you can run the following command to check the spelling of all HTML files:
[source,bash]
--
podman run --rm --volume $(pwd):/spell ghcr.io/vshn/hunspell:1.7.0.2 -d default,vshn -l -H _public/\**/\*.html`
--