# MkDocs LanguageTool Plugin
This is currently a prototype.
It aims to provide high quality spell checking for your documentation.
## Installation
Install it with pip:
```bash
pip install mkdocs-languagetool-plugin
```
## Usage
First as with all MkDocs plugins, add it to your `mkdocs.yml`:
```yaml
plugins:
- search
- languagetool
```
In addition to adding the plugin to your docs, you need to run (or specify) a languagetool server.
### Local languagetool server with docker
You can easily do this with docker:
```bash
docker run --rm -it -p 8081:8010 --name mkdocs-languagetool -e Java_Xmx=2g -d erikvl87/languagetool
```
After you are done, you can stop the languagetool container:
```bash
docker stop mkdocs-languagetool
```
### Remote languagetool server
This can for example be useful if your company / network has a shared languagetool server running somewhere.
You can specify it like this in your `mkdocs.yml`:
```yaml
plugins:
- search
- languagetool:
languagetool_url: http://YOUR_SERVERS_IP_OR_HOSTNAME:8081/v2/check
```
Raw data
{
"_id": null,
"home_page": "https://github.com/six-two/mkdocs-placeholder-plugin",
"name": "mkdocs-languagetool-plugin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "six-two",
"author_email": "pip@six-two.dev",
"download_url": "https://files.pythonhosted.org/packages/ab/36/1c3d0be887e17a775491a45c681ec6e3bc094f109a993a7faedb6b6cdc58/mkdocs_languagetool_plugin-0.0.1.tar.gz",
"platform": null,
"description": "# MkDocs LanguageTool Plugin\n\nThis is currently a prototype.\nIt aims to provide high quality spell checking for your documentation.\n\n## Installation\n\nInstall it with pip:\n```bash\npip install mkdocs-languagetool-plugin\n```\n\n## Usage\n\nFirst as with all MkDocs plugins, add it to your `mkdocs.yml`:\n```yaml\nplugins:\n- search\n- languagetool\n```\n\nIn addition to adding the plugin to your docs, you need to run (or specify) a languagetool server.\n\n### Local languagetool server with docker\n\nYou can easily do this with docker:\n```bash\ndocker run --rm -it -p 8081:8010 --name mkdocs-languagetool -e Java_Xmx=2g -d erikvl87/languagetool\n```\n\nAfter you are done, you can stop the languagetool container:\n```bash\ndocker stop mkdocs-languagetool\n```\n\n### Remote languagetool server\n\nThis can for example be useful if your company / network has a shared languagetool server running somewhere.\nYou can specify it like this in your `mkdocs.yml`:\n```yaml\nplugins:\n- search\n- languagetool:\n languagetool_url: http://YOUR_SERVERS_IP_OR_HOSTNAME:8081/v2/check\n```\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Spellcheck your docs using a LanguageTool server",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/six-two/mkdocs-placeholder-plugin"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9b610cf95aa4f71596b2b7982e49b8189b92bdfe14a483db067dfae3324ea846",
"md5": "bd659d6780a9ead4e390025d30763bbf",
"sha256": "a358c437013ccb1067a083093ec69c257ac2e238ad08e55a7d9036b3be11e806"
},
"downloads": -1,
"filename": "mkdocs_languagetool_plugin-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bd659d6780a9ead4e390025d30763bbf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 4958,
"upload_time": "2025-02-08T03:57:42",
"upload_time_iso_8601": "2025-02-08T03:57:42.580513Z",
"url": "https://files.pythonhosted.org/packages/9b/61/0cf95aa4f71596b2b7982e49b8189b92bdfe14a483db067dfae3324ea846/mkdocs_languagetool_plugin-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ab361c3d0be887e17a775491a45c681ec6e3bc094f109a993a7faedb6b6cdc58",
"md5": "5a57b2f394c5b7a07521ac9eff3c5b29",
"sha256": "11e0aaed3f3668b474a2e1090b2c56d12fe334fc265cde49e18a21b2971b16d4"
},
"downloads": -1,
"filename": "mkdocs_languagetool_plugin-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "5a57b2f394c5b7a07521ac9eff3c5b29",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 3929,
"upload_time": "2025-02-08T03:57:44",
"upload_time_iso_8601": "2025-02-08T03:57:44.608635Z",
"url": "https://files.pythonhosted.org/packages/ab/36/1c3d0be887e17a775491a45c681ec6e3bc094f109a993a7faedb6b6cdc58/mkdocs_languagetool_plugin-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-08 03:57:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "six-two",
"github_project": "mkdocs-placeholder-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "babel",
"specs": [
[
"==",
"2.15.0"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2024.6.2"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"3.3.2"
]
]
},
{
"name": "click",
"specs": [
[
"==",
"8.1.7"
]
]
},
{
"name": "codespell",
"specs": [
[
"==",
"2.3.0"
]
]
},
{
"name": "colorama",
"specs": [
[
"==",
"0.4.6"
]
]
},
{
"name": "editdistpy",
"specs": [
[
"==",
"0.1.4"
]
]
},
{
"name": "ghp-import",
"specs": [
[
"==",
"2.1.0"
]
]
},
{
"name": "gitdb",
"specs": [
[
"==",
"4.0.11"
]
]
},
{
"name": "gitpython",
"specs": [
[
"==",
"3.1.43"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.7"
]
]
},
{
"name": "jinja2",
"specs": [
[
"==",
"3.1.4"
]
]
},
{
"name": "markdown",
"specs": [
[
"==",
"3.6"
]
]
},
{
"name": "markupsafe",
"specs": [
[
"==",
"2.1.5"
]
]
},
{
"name": "mergedeep",
"specs": [
[
"==",
"1.3.4"
]
]
},
{
"name": "mkdocs",
"specs": [
[
"==",
"1.6.0"
]
]
},
{
"name": "mkdocs-badges",
"specs": [
[
"==",
"0.4.2"
]
]
},
{
"name": "mkdocs-get-deps",
"specs": [
[
"==",
"0.2.0"
]
]
},
{
"name": "mkdocs-git-revision-date-localized-plugin",
"specs": [
[
"==",
"1.2.6"
]
]
},
{
"name": "mkdocs-material",
"specs": [
[
"==",
"9.5.27"
]
]
},
{
"name": "mkdocs-material-extensions",
"specs": [
[
"==",
"1.3.1"
]
]
},
{
"name": "mkdocs-spellcheck",
"specs": [
[
"==",
"1.1.0"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"24.1"
]
]
},
{
"name": "paginate",
"specs": [
[
"==",
"0.5.6"
]
]
},
{
"name": "pathspec",
"specs": [
[
"==",
"0.12.1"
]
]
},
{
"name": "platformdirs",
"specs": [
[
"==",
"4.2.2"
]
]
},
{
"name": "pygments",
"specs": [
[
"==",
"2.18.0"
]
]
},
{
"name": "pymdown-extensions",
"specs": [
[
"==",
"10.8.1"
]
]
},
{
"name": "python-dateutil",
"specs": [
[
"==",
"2.9.0.post0"
]
]
},
{
"name": "pytz",
"specs": [
[
"==",
"2024.1"
]
]
},
{
"name": "pyyaml",
"specs": [
[
"==",
"6.0.1"
]
]
},
{
"name": "pyyaml-env-tag",
"specs": [
[
"==",
"0.1"
]
]
},
{
"name": "regex",
"specs": [
[
"==",
"2024.5.15"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.32.3"
]
]
},
{
"name": "six",
"specs": [
[
"==",
"1.16.0"
]
]
},
{
"name": "smmap",
"specs": [
[
"==",
"5.0.1"
]
]
},
{
"name": "symspellpy",
"specs": [
[
"==",
"6.7.7"
]
]
},
{
"name": "types-pyyaml",
"specs": [
[
"==",
"6.0.12.20240311"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"2.2.2"
]
]
},
{
"name": "watchdog",
"specs": [
[
"==",
"4.0.1"
]
]
}
],
"lcname": "mkdocs-languagetool-plugin"
}
JSON
