https://github.com/ian-r-rose/jupyterlab-toc

Table of Contents extension for JupyterLab
https://github.com/ian-r-rose/jupyterlab-toc

Last synced: 18 days ago
JSON representation

Table of Contents extension for JupyterLab

• Host: GitHub
• URL: https://github.com/ian-r-rose/jupyterlab-toc
• Owner: ian-r-rose
• License: bsd-3-clause
• Fork: true (jupyterlab/jupyterlab-toc)
• Created: 2018-06-21T19:20:24.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-04-13T16:18:49.000Z (over 5 years ago)
• Last Synced: 2024-07-31T23:39:39.644Z (3 months ago)
• Language: TypeScript
• Size: 6.16 MB
• Stars: 72
• Watchers: 7
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-jupyterlab - Table of Contents - Generates a table of content for your notebook and markdown documents. (Uncategorized / Uncategorized)

README

        
# 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](https://github.com/jakevdp/PythonDataScienceHandbook):

![Table of Contents](toc.gif 'Table of Contents')

## Prerequisites

- JupyterLab 1.0

## Installation

```bash

jupyter labextension install @jupyterlab/toc

```

## Development

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

```bash

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

```bash

jlpm run watch

```

Then launch JupyterLab using

```bash

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.