Welcome to notebook_magiclight’s documentation!¶
Getting Started¶
To get started, clone the repo to your favorite spot and install the extension:
jupyter nbextension install /path_to_the_repo/notebook_magiclight
Then you will have to enable the extension by:
jupyter nbextension enable notebook_magiclight/index
And you are good to go! No more ugly magic cells!
Code Documentation¶
Functions
-
findMagic(cells)¶ It finds all cell magics that appear in the notebook
- Arguments
cells (Array.<Object>) – All cells in the notebook
- Returns
Array.<string> – - The names of the cell magics
-
searchForCodeMirrorMode(modes)¶ It search for codemirror mode according to the name of cell magic.
- Arguments
modes (Array.<string>) – The names of the cell magics.
- Returns
Object.<string, Object> – - Key: name of the cell magic. Value: the codemirror mode.
-
changeHighlight(mode, mime)¶ It finds all cell magics that appear in the notebook
- Arguments
mode (Array.<string>) – The names of the cell magics.
string> mime (Object.<string,) – Key: the name of the cell magic. Value: a codemirror mime
-
initialize()¶ Initialize the highlighter
-
load_ipython_extension()¶ The load hook function. Triggers when the extension is loaded to Jupyter notebook