showdownjs/showdown

Insert listItem on rule

Open

#636 opened on Jan 3, 2019

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

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

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-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
knowledge of showdown custom rulesJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate how showdown processes list items in its source code (likely in src/showdown.js or src/subParsers/). Look for how the library wraps <li> elements inside <ul> and consider using a higher level rule type (like 'output' instead of 'lang') if possible. Additionally, check if there are existing custom rule examples in the repository's wiki or examples directory.