Skip to content

Ignore contents of <script> tag in spellcheck#40

Merged
pawamoy merged 1 commit intopawamoy:mainfrom
tuxu:ignore-script-tag
Feb 3, 2026
Merged

Ignore contents of <script> tag in spellcheck#40
pawamoy merged 1 commit intopawamoy:mainfrom
tuxu:ignore-script-tag

Conversation

@tuxu
Copy link
Contributor

@tuxu tuxu commented Feb 3, 2026

For reviewers

  • I did not use AI
  • I used AI and thoroughly reviewed every code/docs change

Description of the change

We're using mkdocs-jupyter to render Jupyter notebooks in our documentation, which uses nbconvert. The latest update of nbconvert from 7.16.6 to 7.17.0 triggered an issue with mkdocs-spellcheck:

WARNING -  mkdocs_spellcheck: (codespell) test.ipynb: Misspelled 'curren', did you mean 'current'?
WARNING -  mkdocs_spellcheck: (codespell) test.ipynb: Misspelled 'notin', did you mean 'noting, not in, notion'?

This is because the latest nbconvert release includes a list of HTML entities in a <script> tag.

With this PR, the spellcheck will skip over the <script> contents.

Relevant resources

@pawamoy
Copy link
Owner

pawamoy commented Feb 3, 2026

Thanks for the PR @tuxu. Makes sense to me to ignore the contents of script tags 👍

@pawamoy pawamoy merged commit 80c72bc into pawamoy:main Feb 3, 2026
1 of 10 checks passed
@tuxu
Copy link
Contributor Author

tuxu commented Feb 4, 2026

Thanks a lot for the swift review and merge!

@hodgestar
Copy link

@pawamoy Would it be possible to get a minor release with this fix?

@pawamoy
Copy link
Owner

pawamoy commented Feb 11, 2026

Done!

@hodgestar
Copy link

@pawamoy Woot! Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants