Skip to content

yytrya/jupyterlab-toc

This branch is 184 commits behind jupyterlab/jupyterlab-toc:master.

Folders and files

NameName
Last commit message
Last commit date
Feb 7, 2019
Oct 19, 2018
Aug 20, 2018
Jul 11, 2018
Jul 11, 2018
Mar 14, 2018
Feb 5, 2019
Feb 7, 2019
Sep 11, 2018
Oct 3, 2018
Sep 4, 2018
Feb 7, 2019

Repository files navigation

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 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.

About

Table of Contents extension for JupyterLab

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 88.9%
  • CSS 11.1%