Skip to content

Conversation

@codeleventh
Copy link

@codeleventh codeleventh commented Nov 26, 2025

  • I'm the package's author and/or maintainer.
  • I have have read the docs.
  • I have tagged a release with a semver version number.
  • My package repo has a description and a README describing what it's for and how to use it.
  • My package doesn't add context menu entries. *
  • My package doesn't add key bindings. **
  • Any commands are available via the command palette.
  • Preferences and keybindings (if any) are listed in the menu and the command palette, and open in split view.
  • If my package is a syntax it doesn't also add a color scheme. ***
  • I use .gitattributes to exclude files from the package: images, test files, sublime-project/workspace.

My package is prepending Markdown files with inline Table of Contents

It adds own keybinding (Ctrl+Shift+M)

There are no packages like it in Package Control (that's why I did it, lol).

@braver
Copy link
Collaborator

braver commented Dec 8, 2025

There are no packages like it in Package Control

How about https://packages.sublimetext.io/packages/MarkdownTOC?

Comment on lines 1228 to 1231
"details": "https://github.com/codeleventh/mdtoc",
"readme": "https://github.com/codeleventh/mdtoc/blob/master/README.md",
"labels": ["markdown", "table of contents", "text navigation"],
"author": "codeleventh",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
"details": "https://github.com/codeleventh/mdtoc",
"readme": "https://github.com/codeleventh/mdtoc/blob/master/README.md",
"labels": ["markdown", "table of contents", "text navigation"],
"author": "codeleventh",
"details": "https://github.com/codeleventh/mdtoc",
"labels": ["markdown", "table of contents", "text navigation"],

These keys are not needed.

@braver
Copy link
Collaborator

braver commented Dec 8, 2025

It adds own keybinding (Ctrl+Shift+M)

It looks like this package should just work fine without that. Please comment out your binding, and let that just be an example for users to set their own. That way you're sure it doesn't clash, and users can pick something that makes sense to them (and their OS, e.g. on MacOS you'd usually pick cmd instead of ctrl).

@braver braver added the feedback provided The changes and package have been seen by a reviewer label Dec 8, 2025
@kaste
Copy link
Contributor

kaste commented Dec 8, 2025

Looks wonderful. If I click a heading, it closes the phantom; otherwise it updates them while typing. I think you should keep the table open on click. There is a setting for that already.

@codeleventh
Copy link
Author

@braver, yep, I've removed the excessive fields and default shortcut key.

About MarkdownTOC plugin: it's purpose is different — it's for modifying the document for the reader's convenience. This plugin is for the author's navigation within the document.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feedback provided The changes and package have been seen by a reviewer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants