search

pawamoy / mkdocs-spellcheck

A spell checker plugin for MkDocs.
https://pawamoy.github.io/mkdocs-spellcheck/
ISC License
16 stars 3 forks source link

bug: Documentation is slightly confusing #24

Closed gugulet-hu-spreadai closed 4 hours ago

gugulet-hu-spreadai commented 4 hours ago

What is the install command? What is the exact syntax?

This returns an error: pip install mkdocs-spellcheck[all], same for pip install mkdocs-spellcheck-all

The square brackets are confusing.

pawamoy commented 4 hours ago

Hi @gugulet-hu-spreadai, thanks for reporting this issue.

This returns an error:

What error :wink:?

The square brackets are confusing.

This is the syntax for installing extras, see the spec here: https://packaging.python.org/en/latest/specifications/dependency-specifiers/#extras.

I suppose you are using a shell that actually interprets the square brackets, so what you can do is escape them by putting the package name and the extras between quotes:

pip install 'mkdocs-spellcheck[all]'

I'll update the installation instructions. Let me know if that solves your issue :slightly_smiling_face: