Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ozlerhakan/toci
🗂 markdown tool to create table of content from jupyter notebooks
https://github.com/ozlerhakan/toci
ipynb ipynb-jupyter-notebook jupyter jupyter-notebook markdown notebook python python3 tableofcontents
Last synced: 1 day ago
JSON representation
🗂 markdown tool to create table of content from jupyter notebooks
- Host: GitHub
- URL: https://github.com/ozlerhakan/toci
- Owner: ozlerhakan
- License: mit
- Created: 2021-11-14T11:25:16.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-30T14:19:14.000Z (about 2 years ago)
- Last Synced: 2024-09-18T21:09:09.789Z (7 days ago)
- Topics: ipynb, ipynb-jupyter-notebook, jupyter, jupyter-notebook, markdown, notebook, python, python3, tableofcontents
- Language: Python
- Homepage:
- Size: 8.79 KB
- Stars: 8
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Toci
Toci is a markdown tool to generate an outline from a given Jupyter notebook. It traverses the markdown cells of a given `ipynb` file to form a toc for you.
## How it works
```
$ pip install toci==0.0.3
$ toci --help
usage: toci [-h] [--version] --notebook NOTEBOOK
optional arguments:
-h, --help show this help message and exit
--version show program's version number and exit
--notebook NOTEBOOK, -n NOTEBOOK
an ipynb notebook file
```
Create a table of content from a given ipynb file as follows:
```
$ toci -n notebook.ipynb
# Table of Content
- [Intro](#intro)
- [Heading 2](#heading-2)
- [Heading 3](#heading-3)
- [Another Heading 2](#another-heading-2)
- [Another Heading 2 2](#another-heading-2-2)
- [Another Heading 3](#another-heading-3)
- [Another Heading 4](#another-heading-4)
- [😽 Cat Section](#-cat-section)
- [is another section ready?](#is-another-section-ready)
```
## LICENSE
MIT