starred/BoostNote-App

Fork 0

mirror of https://github.com/BoostIO/BoostNote-App.git synced 2026-04-27 13:25:49 +03:00

[GH-ISSUE #284] Support table of contents #105

New issue

Closed

opened 2026-03-03 00:18:25 +03:00 by kerem · 9 comments

kerem commented

2026-03-03 00:18:25 +03:00

Owner

Originally created by @themattgabriel on GitHub (Jan 11, 2020).
Original GitHub issue: https://github.com/BoostIO/BoostNote-App/issues/284

Current behavior

Adding the lines below in the editor does nothing.

<!-- toc -->

<!-- tocstop -->

The option to add TOC is not available in the menu bar.

Expected behavior

Ctrl + Shift + T changes the view. It no longer generates table of content like it did with old boostnote.

Environment

Version : 0.1.3
OS Version and name : Windows 10

Originally created by @themattgabriel on GitHub (Jan 11, 2020). Original GitHub issue: https://github.com/BoostIO/BoostNote-App/issues/284 # Current behavior  Adding the lines below in the editor does nothing. ```   ``` The option to add TOC is not available in the menu bar. # Expected behavior `Ctrl + Shift + T` changes the view. It no longer generates table of content like it did with old boostnote.  # Environment - Version : 0.1.3 - OS Version and name : Windows 10

kerem

2026-03-03 00:18:25 +03:00

closed this issue
added the
feature request 🌟
label

kerem commented

2026-03-03 00:18:26 +03:00

Author

Owner

@Rokt33r commented on GitHub (Jan 11, 2020):

Implementing TOC generation sounds good to me. But I don't think using  comment is a good idea. To update TOC, the app will modify content of a note again right after editing any headers in the notes. And I don't think the storage need to store the side effect changes. It would make Editor UX and Edit history of the note messier. So I think we need something different. Please let me explain what I'm thinking now.

ToC UI

Provide ToC UI so you can navigate a note without generating TOC.

ToC Shortcode

Using https://github.com/djm/remark-shortcodes, we could introduce new syntax like [[TOC]].

Original content

[[TOC]]

# AAA
# BBB
# CCC

Processed content(This will be rendered on preview and exported)

- [AAA](#aaa)
- [BBB](#bbb)
- [CCC](#ccc)

# AAA
# BBB
# CCC

@Rokt33r commented on GitHub (Jan 11, 2020): Implementing TOC generation sounds good to me. But I don't think using `` comment is a good idea. To update TOC, the app will modify content of a note again right after editing any headers in the notes. And I don't think the storage need to store the side effect changes. It would make Editor UX and Edit history of the note messier. So I think we need something different. Please let me explain what I'm thinking now. ## ToC UI Provide ToC UI so you can navigate a note without generating TOC. ## ToC Shortcode Using https://github.com/djm/remark-shortcodes, we could introduce new syntax like `[[TOC]]`. Original content ``` [[TOC]] # AAA # BBB # CCC ``` Processed content(This will be rendered on preview and exported) ``` - [AAA](#aaa) - [BBB](#bbb) - [CCC](#ccc) # AAA # BBB # CCC ```

kerem commented

2026-03-03 00:18:26 +03:00

Author

Owner

@themattgabriel commented on GitHub (Jan 11, 2020):

<!-- toc -->

<!-- tocstop -->

I was just referring to how it looked like in the old boostnote. I love the idea of having a TOC shortcode to keep it simple.

@themattgabriel commented on GitHub (Jan 11, 2020): > ``` >  > >  > ``` I was just referring to how it looked like in the old boostnote. I love the idea of having a TOC shortcode to keep it simple.

kerem commented

2026-03-03 00:18:26 +03:00

Author

Owner

@Rokt33r commented on GitHub (Jan 11, 2020):

@themattgabriel
Awesome! Then, I'll try to implement this soon! Thanks for sharing your idea.

@Rokt33r commented on GitHub (Jan 11, 2020): @themattgabriel Awesome! Then, I'll try to implement this soon! Thanks for sharing your idea.

kerem commented

2026-03-03 00:18:26 +03:00

Author

Owner

@Airsaid commented on GitHub (Oct 10, 2020):

What is the progress of TOC feature now?

@Airsaid commented on GitHub (Oct 10, 2020): What is the progress of TOC feature now?

kerem commented

2026-03-03 00:18:26 +03:00

Author

Owner

@Rokt33r commented on GitHub (Feb 22, 2021):

@Airsaid Still pending. I'll discuss this issue with my team and reveal our new roadmap soon.

@Rokt33r commented on GitHub (Feb 22, 2021): @Airsaid Still pending. I'll discuss this issue with my team and reveal our new roadmap soon.

kerem commented

2026-03-03 00:18:26 +03:00

Author

Owner

@linuxandroid commented on GitHub (Jun 29, 2021):

What is the progress of TOC feature now?

@linuxandroid commented on GitHub (Jun 29, 2021): What is the progress of TOC feature now?

kerem commented

2026-03-03 00:18:26 +03:00

Author

Owner

@Komediruzecki commented on GitHub (Jun 29, 2021):

Hi, all,

Implemented TOC generation via shortcode toc, the jumping to document line where heading is as well. It needs to be styled a bit, and it should ship in next release.

Thank you for your patience!

@Komediruzecki commented on GitHub (Jun 29, 2021): Hi, all, Implemented TOC generation via shortcode [[toc]], the jumping to document line where heading is as well. It needs to be styled a bit, and it should ship in next release. Thank you for your patience!

kerem commented

2026-03-03 00:18:26 +03:00

Author

Owner

@Komediruzecki commented on GitHub (Aug 9, 2021):

Closing issue as this was released.

@Komediruzecki commented on GitHub (Aug 9, 2021): Closing issue as this was released.

kerem commented

2026-03-03 00:18:26 +03:00

Author

Owner

@maksokami commented on GitHub (Dec 16, 2021):

Closing issue as this was released.

Hi,
Does it also work in Boostnote-local (using Boost Note 0.22.3)? Any instructions on how to make it work?

@maksokami commented on GitHub (Dec 16, 2021): > Closing issue as this was released. Hi, Does it also work in Boostnote-local (using Boost Note 0.22.3)? Any instructions on how to make it work?

kerem referenced this issue

2026-03-03 00:22:11 +03:00

[PR #105] [MERGED] Styled component types #569

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/BoostNote-App#105

No description provided.

Rows
Columns