{"id":25539060,"url":"https://github.com/six-two/mkdocs-languagetool-plugin","last_synced_at":"2025-10-29T03:07:51.114Z","repository":{"id":277826925,"uuid":"928847768","full_name":"six-two/mkdocs-languagetool-plugin","owner":"six-two","description":"Check your MkDocs page with LanguageTool (requires languagetool server)","archived":false,"fork":false,"pushed_at":"2025-02-16T11:40:14.000Z","size":9,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-16T12:25:49.255Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/six-two.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-07T10:51:05.000Z","updated_at":"2025-02-16T11:40:17.000Z","dependencies_parsed_at":"2025-02-16T12:25:51.576Z","dependency_job_id":"2a0d437a-8b42-4081-b428-66fbfc3be0bc","html_url":"https://github.com/six-two/mkdocs-languagetool-plugin","commit_stats":null,"previous_names":["six-two/mkdocs-languagetool-plugin"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/six-two%2Fmkdocs-languagetool-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/six-two%2Fmkdocs-languagetool-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/six-two%2Fmkdocs-languagetool-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/six-two%2Fmkdocs-languagetool-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/six-two","download_url":"https://codeload.github.com/six-two/mkdocs-languagetool-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239784089,"owners_count":19696508,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-20T05:30:23.948Z","updated_at":"2025-10-29T03:07:51.040Z","avatar_url":"https://github.com/six-two.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 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_host: YOUR_SERVERS_IP_OR_HOSTNAME\n```\n\n### Conditional spell checking\n\nSpellchecking causes a lot of CPU load and slows down site builds.\nSo you may want to only run it at certain times (like before creating a new release).\nThis can be done using environment variables that enable or disable the plugin.\nFor example you could use the following snippet in your `mkdocs.yml`:\n```yaml\nplugins:\n- search\n- languagetool:\n    enabled: !ENV [SPELLCHECK, false]\n    languagetool_host: YOUR_SERVERS_IP_OR_HOSTNAME\n```\n\nThen a normal build (`mkdocs build`) would not enable the plugin.\nBut if you want to do the spell checking, you can set the `SPELLCHECK` variable:\n```bash\nSPELLCHECK=true mkdocs serve\n```\n\n## Notable changes\n\n### HEAD\n\n- Renamed some options for better consistency:\n    - Renamed `start_languagetool` to `docker_create_container`.\n    - Renamed `languagetool_docker_image` to `docker_image`.\n    - Renamed `custom_known_words_directory` to `docker_known_words_directory`.\n- Added more options to configure docker:\n    - `docker_binary` for specifying the alternative docker engines like podman.\n    - `docker_container_name` for changing the name of the container.\n    - `docker_custom_arguments` for adding parameters to the `docker run` command.\n\n### Version 0.1.0\n\n- Split `languagetool_url` into `languagetool_protocol`, `languagetool_host` and `languagetool_port`.\n- Added option `custom_known_words_directory` to add known words to all or specific languages.\n- Added option `languagetool_docker_image` to overwrite which docker image (or tag) to use.\n- Added option `write_unknown_words_to_file` to automatically generate a list of unknown / potentially misspelled words.\n- Added options to ignore specific files (`ignore_files`) and specific spelling rules (`ignore_rules`).\n- Added support for automatically starting the LanguageTool server via docker (`start_languagetool` setting).\n- Added parallelized spell checking (via `async_threads`) and enabled it by default.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsix-two%2Fmkdocs-languagetool-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsix-two%2Fmkdocs-languagetool-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsix-two%2Fmkdocs-languagetool-plugin/lists"}