showdownjs/showdown

TOML Metadata surrounded by +++

Open

#868 opened on Oct 8, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (1,640 forks)batch import
enhancementhelp wantedscope:makeHtml

Repository metrics

Stars
 (13,700 stars)
PR merge metrics
 (Avg merge 15h 21m) (3 merged PRs in 30d)

Description

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)

Contributor guide

Research direction
Examine the existing metadata parsing implementation for ` ` delimiters and extend it to handle `+++` delimiters as well. Look for the metadata regex and logic in the source code.
Tech stack
javascript
Domain
tooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
JavaScriptRegular Expressions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40