forked from jupyterlab-contrib/spellchecker
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 3d9d764
Showing
7 changed files
with
1,097 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
*.bundle.* | ||
lib/ | ||
node_modules/ | ||
*.egg-info/ | ||
.ipynb_checkpoints | ||
*~ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# jupyterlab_spellchecker | ||
|
||
A spell checker extension for markdown cells in jupyterlab notebooks. | ||
|
||
Highlights misspelled words. | ||
|
||
Based entirely on [this jupyter notebook extension](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/tree/master/src/jupyter_contrib_nbextensions/nbextensions/spellchecker). | ||
|
||
Uses [Typo.js](https://github.com/cfinke/Typo.js) under the hood for spell checking. | ||
|
||
Currently only uses the `en_US` dictionary loaded from the [jsdelivr.net cdn](https://www.jsdelivr.com/). | ||
|
||
## Prerequisites | ||
|
||
* JupyterLab | ||
|
||
## Installation | ||
|
||
```bash | ||
jupyter labextension install jupyterlab_spellchecker | ||
``` | ||
|
||
## Development | ||
|
||
For a development install (requires npm version 4 or later), do the following in the repository directory: | ||
|
||
```bash | ||
npm install | ||
npm run build | ||
jupyter labextension link . | ||
``` | ||
|
||
To rebuild the package and the JupyterLab app: | ||
|
||
```bash | ||
npm run build | ||
jupyter lab build | ||
``` | ||
|
Oops, something went wrong.