Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jupyterlab/jupyterlab-toc
Table of Contents extension for JupyterLab
https://github.com/jupyterlab/jupyterlab-toc
jupyter jupyterlab jupyterlab-extension
Last synced: 17 days ago
JSON representation
Table of Contents extension for JupyterLab
- Host: GitHub
- URL: https://github.com/jupyterlab/jupyterlab-toc
- Owner: jupyterlab
- License: bsd-3-clause
- Archived: true
- Created: 2018-03-12T15:55:19.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-07-07T04:18:47.000Z (over 2 years ago)
- Last Synced: 2024-07-31T23:39:40.947Z (3 months ago)
- Topics: jupyter, jupyterlab, jupyterlab-extension
- Language: TypeScript
- Size: 6.47 MB
- Stars: 727
- Watchers: 30
- Forks: 107
- Open Issues: 75
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-jupyter-resources - GitHub - 55% open · ⏱️ 10.08.2021): (JupyterLab扩展)
README
# jupyterlab-toc
## Archived
**This project is archived. Development is now happening in https://github.com/jupyterlab/jupyterlab.**
This extension was added to the core JupyterLab extensions for JupyterLab 3.0. Anyone using JupyterLab < 3.0 should use this extension, but anyone using JupyterLab >= 3.0 will already have this extension installed with the core JupyterLab extensions. Any issues or pull requests should be added to the [JupyterLab repo](https://github.com/jupyterlab/jupyterlab).
[![Binder][badge-binder]][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][python-data-science-handbook]:
## Prerequisites
- JupyterLab >=2.0
- NodeJS 12+
## Installation
```bash
jupyter labextension install @jupyterlab/toc
```
## Settings
Once installed, extension behavior can be modified via the following settings which can be set in JupyterLab's advanced settings editor:
- **collapsibleNotebooks**: enable the ability to collapse sections of notebooks from the 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.
[badge-binder]: https://mybinder.org/badge_logo.svg
[binder]: https://mybinder.org/v2/gh/jupyterlab/jupyterlab-toc/master?urlpath=lab%2Ftree%2Fnotebooks%2Fdemo.ipynb
[python-data-science-handbook]: https://github.com/jakevdp/PythonDataScienceHandbook