Skip to content

fix(docs): replace HTML heading tags with standard Markdown headings and fix hierarchy - #72

Open
not-knope wants to merge 1 commit into
baidu:mainfrom
not-knope:fix/readme-markdown-headings
Open

fix(docs): replace HTML heading tags with standard Markdown headings and fix hierarchy#72
not-knope wants to merge 1 commit into
baidu:mainfrom
not-knope:fix/readme-markdown-headings

Conversation

@not-knope

Copy link
Copy Markdown

Description

This PR fixes Markdown heading rendering and outline generation issues reported in #68.

Changes Made:

  • Replaced raw HTML <h1 align=center>\ and <h3 align=center>\ tags in \README.md\ with standard Markdown #\ / ##\ headings wrapped in <div align=center>. This allows GitHub, Hugging Face, and Markdown parsers to register them in document outlines/table of contents while preserving visual centering.
  • Fixed heading level skipping under ### vLLM\ (##### Docker Images\ -> #### Docker Images).
  • Fixed section heading level in \CONTRIBUTING.md\ (# Chinese version\ -> ## Chinese Version).
  • Added an automated test script (\ ests/test_markdown_headings.py) to validate Markdown heading syntax and hierarchy.

Fixes #68

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Markdown headings are not rendering correctly (missing # symbols)

1 participant