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

Notebook Outline-View and Breadcrumbs. #13562

Merged
merged 6 commits into from
Apr 5, 2024

Conversation

jonah-iden
Copy link
Contributor

@jonah-iden jonah-iden commented Apr 3, 2024

What it does

this adds support for the outline view and breadcrumbs for the notebook editor.
Also makes the jupyter Show Table of contents menu item working in the main notebook toolbar since its only opening the outline view.

How to test

Create or open a notebook and see the breadcrumbs showing all cells.
Trust the workspace and click Show Table of contents (Outline View) to reveal the outline view.
Changing selection in editor or outline view should reflect respectivley

Follow-ups

There is currently no markdown based hirachy yet. That needs to be implemented later. Same as only showing code cells in the breadcrumbs and not in the outline view

Review checklist

Reminder for reviewers

+ jupyter show Table of contents menu item working

Signed-off-by: Jonah Iden <jonah.iden@typefox.io>
@jonah-iden jonah-iden requested a review from msujew April 3, 2024 14:45
@jonah-iden jonah-iden changed the title Notebook Outlineview and Breadcrumbs. Notebook Outline-View and Breadcrumbs. Apr 3, 2024
Copy link
Member

@msujew msujew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a significant difference between the generated outline in vscode and Theia. Theia shows all cells (both markdown and code) in a flat list. In vscode, only markdown cells are shown, but in a hierarchical tree (depending on the level of heading):

image

Also, the label for those outline nodes isn't just the raw text, but the markdown rendered to plain text. Elements like **Hello** or `Hello` just become Hello.

Signed-off-by: Jonah Iden <jonah.iden@typefox.io>
Signed-off-by: Jonah Iden <jonah.iden@typefox.io>
@jonah-iden
Copy link
Contributor Author

As said in the followups markdown based hirachy and only showing markdown cells in outline is coming with a later PR

@jonah-iden jonah-iden requested a review from msujew April 4, 2024 08:16
Copy link
Member

@msujew msujew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright, works for me 👍

Co-authored-by: Mark Sujew <mark.sujew@typefox.io>
@jonah-iden jonah-iden merged commit 52ab029 into master Apr 5, 2024
14 checks passed
@jonah-iden jonah-iden deleted the jiden/notebook-outline-and-breadcrumbs branch April 5, 2024 09:49
@github-actions github-actions bot added this to the 1.49.0 milestone Apr 5, 2024
@msujew msujew added the notebook issues related to notebooks label Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
notebook issues related to notebooks
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants