https://github.com/c-bata/mkdocs-term-validator

mkdocs port of https://github.com/shimizukawa/sphinx-term-validator
https://github.com/c-bata/mkdocs-term-validator

Last synced: 14 days ago
JSON representation

mkdocs port of https://github.com/shimizukawa/sphinx-term-validator

• Host: GitHub
• URL: https://github.com/c-bata/mkdocs-term-validator
• Owner: c-bata
• License: apache-2.0
• Created: 2022-08-01T13:00:01.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-02T09:28:23.000Z (over 2 years ago)
• Last Synced: 2024-10-08T21:06:32.126Z (about 1 month ago)
• Language: Python
• Size: 206 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mkdocs-term-validator

mkdocs port of https://github.com/shimizukawa/sphinx-term-validator

![example](./example.png)

## Installation

```

$ pip install git+https://github.com/c-bata/mkdocs-term-validator.git

```

## Usage

```yaml

# mkdocs.yml

plugins:

    - term-validator:

        rule_dic_file: ng-word.txt

```

## License

The source code is released under [Apache License 2.0](./LICENSE) except for `example-rule-dic.txt`, which is taken from https://github.com/shimizukawa/sphinx-term-validator