commonmark / commonmark/commonmark.js

[Example]: Extended HTML renderer

Open
#275 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
1.6k
Forks
231
Avg merge
2d 11h
Merged PRs (30d)
3

Description

How to properly extended existing HTML renderer, with eg.: striketrough feature, I want to ~~~sample~~~ , to render into sample

HtmlRenderer.prototype.attribute = `~~~`; // I don't how to map new attribute with del fn,
HtmlRenderer.prototype.del = (text) => `<del>${text}</del>`;

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the existing HtmlRenderer implementation and its attribute and del methods. Trace how input attributes are mapped to renderer methods, then verify how the sample strikethrough syntax is parsed and rendered. Done means the extension path is documented or implemented clearly enough to produce the requested del output.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
web-dev
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.