ashwinvis / ashwinvis/myst-reader

Support reading of title from H1 element

Open
#48 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
Python
Stars
8
Forks
2
PR merge metrics
No merged PRs in 30d

Description

The Markdown module can substitute `title` value by the value of the first H1 element present in the body of text. That makes the Markdown document more generic and less bound to the particular reader. Would it be possible to extend `myst-reader` to be able to do it as well, please?

Contributor guide

Open the contributing guide

Research direction

Start by locating the myst-reader path that currently determines a document's title and inspect how the first H1 is exposed by the Markdown/MyST parser. The work is done when a document without an explicit title can use its first H1 as the title without changing documents that already provide one.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
content
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.