mirror of
https://github.com/vinta/awesome-python.git
synced 2026-11-21 15:21:30 +00:00
docs: document empirically verified README parsing behavior
Capture parser quirks worth knowing before editing README.md: everything above is ignored, new subcategories need no parser change, a standalone all-bold paragraph becomes a Thematic Group marker, prose after leaks into llms.txt, and the build's "Total entries" figure counts sub-items rather than just entries. Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
parent
2c50d9e63a
commit
2c2ce2fcac
1 changed files with 10 additions and 1 deletions
|
|
@ -1,4 +1,13 @@
|
|||
"""Parse README.md into structured section data using markdown-it-py AST."""
|
||||
"""Parse README.md into structured section data using markdown-it-py AST.
|
||||
|
||||
Empirically verified behavior worth knowing before editing README.md:
|
||||
everything above `## Projects` is ignored; new subcategories need no
|
||||
parser change (a bullet without a leading link plus indented entries);
|
||||
a standalone all-bold paragraph inside the Projects region becomes a
|
||||
Thematic Group marker; prose placed right after `## Categories` leaks
|
||||
into llms.txt; the build's "Total entries" figure counts sub-items
|
||||
(indented links under an entry), not just entries.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue