{"id":26665687,"url":"https://github.com/christopherkenny/spellcheck","last_synced_at":"2025-03-25T17:37:53.382Z","repository":{"id":283206502,"uuid":"838362221","full_name":"christopherkenny/spellcheck","owner":"christopherkenny","description":"A Quarto filter to print misspelled words to the console using Hunspell","archived":false,"fork":false,"pushed_at":"2025-03-19T03:45:06.000Z","size":3,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-19T04:29:06.856Z","etag":null,"topics":["quarto","quarto-extension","quarto-filter","quartopub"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/christopherkenny.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2024-08-05T13:38:31.000Z","updated_at":"2025-03-19T03:45:09.000Z","dependencies_parsed_at":"2025-03-19T04:39:10.853Z","dependency_job_id":null,"html_url":"https://github.com/christopherkenny/spellcheck","commit_stats":null,"previous_names":["christopherkenny/spellcheck"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christopherkenny%2Fspellcheck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christopherkenny%2Fspellcheck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christopherkenny%2Fspellcheck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christopherkenny%2Fspellcheck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/christopherkenny","download_url":"https://codeload.github.com/christopherkenny/spellcheck/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245511419,"owners_count":20627391,"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":["quarto","quarto-extension","quarto-filter","quartopub"],"created_at":"2025-03-25T17:37:52.789Z","updated_at":"2025-03-25T17:37:53.361Z","avatar_url":"https://github.com/christopherkenny.png","language":"Lua","funding_links":[],"categories":[],"sub_categories":[],"readme":"# spellcheck Extension For Quarto\n\nThis extension provides a filter to run [Hunspell](https://hunspell.github.io/) every time a `.qmd` file is rendered and prints any misspellings to the console.\n\nYou must have Hunspell installed for this to run.\nFor Windows, the [portable version from Chocolately](https://community.chocolatey.org/packages/hunspell.portable) seems to run well (`choco install hunspell.portable`).\nOn Mac, you can install with Homebrew (`brew install hunspell`).\n\n## Installing\n\nFrom a directory with an existing Quarto file or project, run:\n\n```bash\nquarto add christopherkenny/spellcheck\n```\nThis will install the extension under the `_extensions` subdirectory.\nIf you're using version control, you will want to check in this directory.\n\n## Using\n\nAdd the following to your metadata after installing as above.\n\n```yaml\nfilters:\n  - spellcheck\n```\n\nThis will print to the console, something which looks like:\n\n```bash\nPossibly misspelled words:\n--------------------------\nconsol\nlistd\nspelld\n--------------------------\n```\n\nThe default language used is `en_US`. This can be configured by setting:\n\n```yaml\nspellcheck-lang: en_US\n```\n\nIf you specify a spelling language which cannot be found by Hunspell, the program will error.\n\nYou can also specify words to ignore:\n\n```yaml\nspellcheck-ignore:\n  - words\n```\n\nNote: This will create a file `.spellcheck.txt` in the current directory which will be automaticaly removed, during normal functioning. If it fails during the Hunspell step, then you may need to remove that file.\n\n## Example\n\nHere is the source code for a minimal example: [example.qmd](example.qmd).\n\n## Licensing\n\nThe original Lua filter for pandoc is licensed under MIT from [John MacFarlane](https://github.com/pandoc/lua-filters/blob/master/spellcheck/spellcheck.lua).\nAll modifications by me are licensed under the MIT license.\nSee the [license file](LICENSE) for futher details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchristopherkenny%2Fspellcheck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchristopherkenny%2Fspellcheck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchristopherkenny%2Fspellcheck/lists"}