-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Description
Current behavior
Seems to be based upon closed "[Feature request] Automatically generated TOC #1436", but I'm still hoping for a little more, which there is president for in other MarkDown editors.
Can generate, and re-generate a table of contents while editing... Or you can forget to, and the actual contents get out of sync with the one displayed. 😞 Also, there's an issue #3020 open, where the links don't actually jump to the appropriate heading. (I can confirm this, and would suspect it's related to switching to edit mode on focus? Not sure.)
Expected behavior
I'm looking for a [TOC] MarkDown tag, which should generate the table of contents in preview, from the single, static tag in the source.
Existing MarkDown editors which support this include (but not limited to) Typora, and Haroopad. I'm particularly fond of Haroopad supporting "float" attributes to tags, including [TOC], documented here but that's neither essential, nor as widely accepted. (in fact, including the attributes breaks the tag in most other MD editors / readers)
Steps to reproduce
Erm... Well, I'm requesting a feature which seems common to many, but not all, MarkDown editors, and not supported yet in Boostnote. The closest features current operation would be:-
- If you include "[TOC]" or "[toc]" in the editor, it's displayed just as you typed it. With no additional formatting in preview.
- If you Ctrl + Shift + T in the editor it generates code like:-
<!-- toc -->
* [Network Infrastructure](#Network-Infrastructure)
+ [Switching Concepts](#Switching-Concepts)
- [VLA](#VLA)
- [Trunk/Uplink](#TrunkUplink)
+ [Switch Management](#Switch-Management)
- [Tools and Software](#Tools-and-Software)
- [Connecting to a switch](#Connecting-to-a-switch)
- [Login to Switch](#Login-to-Switch)
- [Login to HP 19xx series Switch](#Login-to-HP-19xx-series-Switch)
- [Putting switch into management mode](#Putting-switch-into-management-mode)
- [Network/VLAN Management](#NetworkVLAN-Management)
- [Listing VLANs](#Listing-VLANs)
- [Create VLANs](#Create-VLANs)
- [Delete VLANs](#Delete-VLANs)
- [List VLANs attached to ports](#List-VLANs-attached-to-ports)
- [Add VLAN to port (single vlan port)](#Add-VLAN-to-port-single-vlan-port)
- [Delete VLAN from a port (single vlan port)](#Delete-VLAN-from-a-port-single-vlan-port)
- [Add VLAN to a port (trunk/uplink port)](#Add-VLAN-to-a-port-trunkuplink-port)
- [Delete VLAN from a port (trunk/uplink port)](#Delete-VLAN-from-a-port-trunkuplink-port)
- [Set port as trunk/uplink port](#Set-port-as-trunkuplink-port)
- [Set port as single vlan port](#Set-port-as-single-vlan-port)
- [Finding trunk/uplink ports](#Finding-trunkuplink-ports)
* [Cisco switch showing trunk/uplink information](#Cisco-switch-showing-trunkuplink-information)
- [List management IP addresses for switch](#List-management-IP-addresses-for-switch)
+ [Useful Tips](#Useful-Tips)
- [Finding a device](#Finding-a-device)
- [Network Topology](#Network-Topology)
+ [Core Switch/Site Cloud Links](#Core-SwitchSite-Cloud-Links)
+ [Site Specific Infrastructure](#Site-Specific-Infrastructure)
<!-- tocstop -->
(example taken from one of my more long-winded notes)
This code isn't updated as you add, modify, or remove headings from your note, and it's rather long-winded, though what it produces in the preview is pretty much as I'd hope [toc] would produce. (aforementioned bug #3020 excepted)
Environment
- Version : Boostnote 0.11.16
- OS Version and name : I use Boostnote mostly on Windows 10, and elementaryOS Juno. (Ubuntu 18.09 derivative) But also run on High Sierra, and other Linux. Notes stored in cloud and shared between them... The feature seems to behave the same regardless. (which is good, and as expected)
IssueHunt Summary
hikerpig has been rewarded.
Backers (Total: $40.00)
boostio ($40.00)
Submitted pull Requests
Tips
- Checkout the Issuehunt explorer to discover more funded issues.
- Need some help from other developers? Add your repositories on IssueHunt to raise funds.
IssueHunt has been backed by the following sponsors. Become a sponsor