Table of Contents extension for JupyterLab
Clone or download
Latest commit fdc5154 Oct 26, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src adjustments Oct 26, 2018
style New tag dropdown Oct 19, 2018
.gitignore added some comments Aug 20, 2018
.prettierignore Make the codebase prettier. Jul 11, 2018
.prettierrc Make the codebase prettier. Jul 11, 2018
LICENSE Add license. Mar 14, 2018
README.md Bump to final versions. Oct 5, 2018
package.json Bump to final versions. Oct 5, 2018
toc.gif Update demo gif. Sep 11, 2018
tsconfig.json Update for jlab 0.35 prerelease Oct 3, 2018
tslint.json Add a bunch of copyrights. Sep 4, 2018
yarn.lock Bump to final versions. Oct 5, 2018

README.md

jupyterlab-toc

A Table of Contents extension for JupyterLab. This auto-generates a table of contents in the left area when you have a notebook or markdown document open. The entries are clickable, and scroll the document to the heading in question.

Here is an animation showing the extension's use, with a notebook from the Python Data Science Handbook: Table of Contents

Prerequisites

  • JupyterLab v0.35

Installation

jupyter labextension install @jupyterlab/toc

Development

For a development install, do the following in the repository directory:

jlpm install
jlpm run build
jupyter labextension install .

You can then run JupyterLab in watch mode to automatically pick up changes to @jupyterlab/toc. Open a terminal in the @jupyterlab/toc repository directory and enter

jlpm run watch

Then launch JupyterLab using

jupyter lab --watch

This will automatically recompile @jupyterlab/toc upon changes, and JupyterLab will rebuild itself. You should then be able to refresh the page and see your changes.