Skip to content
This repository has been archived by the owner on May 16, 2023. It is now read-only.

Commit

Permalink
Remove markdown-spellcheck
Browse files Browse the repository at this point in the history
  • Loading branch information
MikeMcC399 committed Jun 9, 2022
1 parent 0011ed3 commit 9f7f33b
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 1,367 deletions.
5 changes: 0 additions & 5 deletions .github/workflows/checks.yml
Expand Up @@ -34,11 +34,6 @@ jobs:
run: |
npm run-script checklinks
#- name: Spellchecking english
# if: always()
# run: |
# npm run-script spellcheck

#- name: Detect inconsiderate language
# if: always()
# run: |
Expand Down
123 changes: 0 additions & 123 deletions .spelling

This file was deleted.

41 changes: 4 additions & 37 deletions INSTALL.md
Expand Up @@ -10,7 +10,6 @@
## Features

* Linting of markdown documents
* Spell checking
* Link checking

## Specifications
Expand All @@ -19,12 +18,6 @@ This repository checks against following specification:

* [Markdown Commonmark](https://spec.commonmark.org/)

### Languages

Supported languages are:

* [English US](https://en.wikipedia.org/wiki/ISO/IEC_8859-1)

## Prerequisites

Install the Node.js 16 Active LTS version of [Node.js](https://nodejs.org/en/) (which includes npm).
Expand All @@ -41,7 +34,7 @@ This installs all dependencies into a local `node_modules` folder.

## Checks

To enforce good spelling and specification conformity there are several checks defined as `npm run-script` targets. To run all checks please execute:
To enforce specification conformity there are several checks defined as `npm run-script` targets. To run all checks please execute:

```shell
npm test
Expand All @@ -53,7 +46,7 @@ If you want to run individual checks see the targets and the description below.
Every individual check can be run like so:

```shell
npm runscript my-individual-check
npm run-script my-individual-check
```

See the [package.json](package.json) file for the currently available scripts.
Expand All @@ -68,7 +61,7 @@ npm run-script markdownlint

##### Markdown linter overrides

Sometimes it is not possible to be commonmark conform. In this rare cases an inline tag to skip linting is possible.
Sometimes it is not possible to be commonmark conform. In these rare cases an inline tag to skip linting is possible.

Candidates are tables.

Expand Down Expand Up @@ -99,32 +92,6 @@ like this:
For more information how to tweak overrides consult the markdown linter
documentation mentioned above.

#### Spell checker

##### English

Spell checking in American English (en_US).

```shell
npm run-script spellcheck
```

##### German

Not implemented yet.

##### Spell checker overrides

Add any additional words to the .spelling file and use the target to sort and
clean them before adding these to master.

```shell
npm run-script format-spelling
```

Please note sometimes overriding is not the way to go. Our terminology should be
applied consistently.

#### Link resolver

All cross references and external URLs are resolved.
Expand All @@ -135,7 +102,7 @@ npm run-script checklinks

#### Inconsiderate language scanner

This checks against profanity and inconsiderate language. This is help full for
This checks against profanity and inconsiderate language. This is helpful for
non-natives to detect words that could be inconsiderate. This utilizes [alex](https://github.com/get-alex/alex)

```shell
Expand Down

0 comments on commit 9f7f33b

Please sign in to comment.