abpframework / abpframework/abp

Docs: Get title of the document from the markdown content header

Open
#17,795 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

abp-module-docs
Dominant language
C#
Stars
14.4k
Forks
3.7k
Avg merge
15h 32m
Merged PRs (30d)
106

Description

Currently, the title of the page is using the file path for the related page. For example, when this page being rendered, the title become as follow:

image

For this case, it would be better to set the title as Getting-Started-with-the-MAUI. Therefore, we can try to get the h1 header from the content and use it as the title if it exists, otherwise, we can use the current approach and use and normalize the file path and use it as the title.

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

No implementation files or tests are named. Start by tracing how a Markdown page's title is currently derived from its file path, then locate the rendering or title-generation entry point and related tests. Done means an H1 supplies the title when present, while pages without one retain the normalized file-path fallback.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
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.