marktext / marktext/marktext

Hide heading attributes in sidebar navigation

Open
#688 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

:unicorn: feature request
Dominant language
TypeScript
Stars
61.6k
Forks
4.6k
Avg merge
23h 49m
Merged PRs (30d)
89

Description

Some Markdown dialects (I'm using Pandoc) allow headings to be tagged various ways, often adding an ID tag, sometimes a class, and in my case even some other meta data (timestamps corresponding to the location in a video file).

This information clutters up the sidebar header navigation considerably. Anything in {} braces after headers should probably be filtered out of that view.

For example the following Markdown:

# Heading {#top}

Content

...should not show the ID attribute markup ({#top}) in the sidebar. Here's an example of what it starts looking like:

image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the sidebar header navigation and how Markdown headings are parsed or rendered there; the issue provides the {#top} example as the expected input. Done means attributes in braces after headings no longer appear in the sidebar while the heading text remains visible.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, typescript
Domain
frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.