Skip to content
/ hunspell Public

Docker image used to spell check the contents of documents produced at VSHN.

Notifications You must be signed in to change notification settings

vshn/hunspell

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Hunspell for VSHN

This project builds a container image encapsulating 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:

podman run --rm --volume $(pwd):/spell ghcr.io/vshn/hunspell:1.7.0.2 -d default,vshn -l -H _public/\**/\*.html`

About

Docker image used to spell check the contents of documents produced at VSHN.

Resources

Stars

Watchers

Forks

Packages