feat: add Insert Link to Header in File command for markdown#306561
Open
yogeshwaran-c wants to merge 1 commit intomicrosoft:mainfrom
Open
feat: add Insert Link to Header in File command for markdown#306561yogeshwaran-c wants to merge 1 commit intomicrosoft:mainfrom
yogeshwaran-c wants to merge 1 commit intomicrosoft:mainfrom
Conversation
Add a new 'Markdown: Insert Link to Header in File' command that shows a quick pick with all headers in the current document, allowing users to search by natural header text (with spaces) and insert a properly slugified markdown link. This addresses the issue where searching for headers in the suggest widget requires using dashes instead of spaces. The new command provides a dedicated quick pick UI for header link insertion, similar to the existing 'Insert Link to File in Workspace' command.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
Feature — adds a new command to the markdown-language-features extension.
What is the current behavior?
When writing markdown links to headers (e.g.,
[text](#header-name)), users must type the slugified header name with dashes instead of spaces in the suggest widget. There is no way to search for headers using their natural text with spaces.Closes #174999
What is the new behavior?
Adds a new Markdown: Insert Link to Header in File command (
markdown.editor.insertHeaderLink) that:vscode.executeDocumentSymbolProvidera-header-with-spaces-in-the-title)[Header Text](#slug)at the cursor positionThis follows the approach suggested by @mjbvz in the issue: a dedicated command with a quick pick UI, similar to how
Markdown: Insert Link to File in Workspaceworks.Implementation details
InsertHeaderLinkclass ininsertResource.ts, following the sameCommandpattern asInsertLinkFromWorkspaceandInsertImageFromWorkspaceISlugifier(GitHub-compatible) to generate correct slugs, including handling of duplicate headersDocumentSymbolhierarchy to collect all headersSnippetStringwith a placeholder for the link text when no text is selectedAdditional context
The command is available in the Command Palette as "Markdown: Insert Link to Header in File" whenever a markdown file is active in the editor.