kgryte 6d4e37d6ac Update Python version %!s(int64=5) %!d(string=hai) anos
..
binder 2a92c71288 Fix build sequence %!s(int64=5) %!d(string=hai) anos
notebooks 6d4e37d6ac Update Python version %!s(int64=5) %!d(string=hai) anos
src b387e9f960 Add comment %!s(int64=5) %!d(string=hai) anos
style c7cecf12e8 v1.0.0-rc.0 %!s(int64=5) %!d(string=hai) anos
.gitignore 1673e368cc added some comments %!s(int64=6) %!d(string=hai) anos
.prettierignore d24e666ca6 Make the codebase prettier. %!s(int64=6) %!d(string=hai) anos
.prettierrc d24e666ca6 Make the codebase prettier. %!s(int64=6) %!d(string=hai) anos
LICENSE 3ea740cce3 Add license. %!s(int64=7) %!d(string=hai) anos
README.md 654e292e9e Update link %!s(int64=5) %!d(string=hai) anos
package.json 437e184037 v1.0.1 %!s(int64=5) %!d(string=hai) anos
toc.gif fefeeac473 Update demo gif. %!s(int64=6) %!d(string=hai) anos
tsconfig.json 10f74e8a11 Update for jlab 0.35 prerelease %!s(int64=6) %!d(string=hai) anos
tslint.json d8c17aa369 Add a bunch of copyrights. %!s(int64=6) %!d(string=hai) anos
yarn.lock e823e814a7 Merge pull request #95 from jupyterlab/dependabot/npm_and_yarn/lodash-4.17.14 %!s(int64=5) %!d(string=hai) anos

README.md

jupyterlab-toc

Binder

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 >=1.0

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.