Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Table of content (toc) for notebooks #3878

Closed
mocquin opened this issue Feb 15, 2018 · 3 comments
Closed

Table of content (toc) for notebooks #3878

mocquin opened this issue Feb 15, 2018 · 3 comments
Labels
status:resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion.
Milestone

Comments

@mocquin
Copy link

mocquin commented Feb 15, 2018

So far I've been using jupyter notebooks with a great nb-extension called toc2. Examples can be found in the doc.

Everything is detailed on the dedicated page, but basically, here is what it does:

  • based on the markdown content of the notebook, it automatically adds number or letter to header lines (which makes the first level 1 header "1", the second level 1 header "2", the second level 2 header in the second level 1 header "2.2", and so on)
  • then creates a table of content in an HTML cell at the top of the notebook, with links to the corresponding headers of the notebook
  • allows you to display a tab (dragable, sizeable, dockable) with the same table of content, that you can click to go to any header in your notebook
  • there is also a "navigate" menu at the top of the notebook, which once again allows you to browse your notebook based on the markdown header content.

There is already an issue on the jupyter-notebook project, but the solution is simply to use the notebook extension...

From what I understood (correct me if I'm wrong), not all the nb-extensions can be used with jupyterlab, and I would love to have this kind of "table of content" in the notebook within jupyterlab.

I'm not saying I would like to have the exact same functionalities, but for me the automatical-numbered header and at least one way to browse the notebook with the headers are some really powerful tools for UX.

@jasongrout jasongrout added this to the Future milestone Feb 15, 2018
@vidartf
Copy link
Member

vidartf commented Feb 16, 2018

Duplicate of #723?

@mocquin
Copy link
Author

mocquin commented Feb 16, 2018

Yes indeed. I coudn't find it with a "table of content" search, didn't thought to try "table of contentS"...

@ebeisaac
Copy link

ebeisaac commented Apr 4, 2018

This link worked for me:
https://www.npmjs.com/package/jupyterlab-toc

@lock lock bot added the status:resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion. label Aug 8, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Aug 8, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
status:resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion.
Projects
None yet
Development

No branches or pull requests

4 participants