showdownjs/showdown

TOML Metadata surrounded by +++

Open

#868 创建于 2021年10月8日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)JavaScript (13,700 star) (1,640 fork)batch import
enhancementhelp wantedscope:makeHtml

描述

Hugo allows TOML metadata (surrounded by +++) - so it's a popular encoding for metadata in files. It would be great if showdown could support it.

Readme says as of today:

metadata: (boolean) [default false] Enable support for document metadata (defined at the top of the document between ««« and »»» or between --- and ---). (since v.1.8.5)

贡献者指南

技术栈
javascript
领域
tooling
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic JavaScriptunderstanding of regex
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
Look at the showdown source code, specifically the file where metadata parsing is implemented (likely in src/subParsers/makeHtml.js or similar). The existing metadata support handles delimiters ` ` and `««« ... »»»`. To add TOML (`+++`), you need to modify the parser to recognize `+++` as a valid metadata delimiter, following the same pattern. Check the function that extracts metadata (e.g., `extractMetadata` or inline in the main parsing loop). Also verify that the TOML format itself is not parsed by showdown; the issue is only about the delimiter, not the content. Add a test case for TOML metadata and ensure existing tests pass. Since the issue is stale, it's recommended to comment on the issue to claim it before starting work.