showdownjs/showdown

Insert listItem on rule

Open

#636 opened on Jan 3, 2019

View on GitHub
 (3 comments) (0 reactions) (1 assignee)JavaScript (1,640 forks)batch import
help wanted

Repository metrics

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

Description

Hi!

Sorry for opening an issue for a question but couldnt find any issue related.

I'm trying to insert a listItem from a rule, the idea is that I'm creating a custom markdown rule that should insert a custom list (LI) element but seems like I cant insert a <li> element without a parent <ul> (which makes sense).

This is a sample of what im trying to achieve:

{
      type: 'lang',
      regex: /(^|\n)(listitem)\n/g,
      replace() {
        return `<li>List Item</li>\n`;
      },
}

Any idea of how can I achieve this?

Contributor guide

Research direction
To insert a listItem without a parent ul, you need to either wrap it in a ul element or use showdown's custom extension API to create a block level list. The current approach with regex replace directly outputs <li> which is invalid HTML without a parent <ul>. Consider using showdown's extension system to process markdown in a structured way, or wrap the <li> in <ul> tags in your replace function.
Tech stack
javascript
Domain
tooling
Issue type
Research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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.
Clear
Prerequisites
showdownregular expressions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70