README.md

Cspell Django Dictionary

Django dictionary for cspell.

This is a pre-built dictionary for use with cspell.

Global Install and add to cspell global settings.

npm install -g @cspell/dict-django
cspell link add @cspell/dict-django

cspell link remove @cspell/dict-django

The cspell-ext.json file in this package should be added to the import section in your cspell.json file.

{
    // …
    "import": ["@cspell/dict-django/cspell-ext.json"],
    // …
}

This dictionary is generated from django's official documentation index : https://docs.djangoproject.com/en/`VERSION`/genindex/. To update it, edit update.pyto match wanted django's VERSION, install requirements (requests and BeautifulSoup) and run the script :

pip install -r requirements.txt
python update.py

Building is only necessary if you want to modify the contents of the dictionary. Note: Building will take a few minutes for large files.

npm run build

WTFPL