Skip to content

Commit

Permalink
first
Browse files Browse the repository at this point in the history
  • Loading branch information
ijmbarr committed Apr 2, 2018
0 parents commit 3d9d764
Show file tree
Hide file tree
Showing 7 changed files with 1,097 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
*.bundle.*
lib/
node_modules/
*.egg-info/
.ipynb_checkpoints
*~
39 changes: 39 additions & 0 deletions README.md
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
```

Loading

0 comments on commit 3d9d764

Please sign in to comment.