Skip to content

Add Node.js usage example to README#3983

Merged
UziTech merged 1 commit into
markedjs:masterfrom
DBartel927:NodeAdd
Jun 1, 2026
Merged

Add Node.js usage example to README#3983
UziTech merged 1 commit into
markedjs:masterfrom
DBartel927:NodeAdd

Conversation

@DBartel927
Copy link
Copy Markdown
Contributor

Marked version: master

Markdown flavor: n/a

Description

  • Fixes 3982

This PR adds a short Node.js usage example to the README. The README already includes CLI and Browser examples, but it did not include a small Node.js package usage example. Since Marked can be used on a server, this adds a simple example showing how to import marked, parse a Markdown string, and use the resulting HTML.

Contributor

  • Test(s) exist to ensure functionality and minimize regression (if no tests added, list tests covering this PR); or,
  • no tests required for this PR.
  • If submitting new feature, it has been documented in the appropriate places.

Committer

In most cases, this should be a different person than the contributor.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 31, 2026

@DBartel927 is attempting to deploy a commit to the MarkedJS Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the README.md file to include a Node.js usage example demonstrating how to import and use the 'marked' library to parse markdown. There are no review comments, so no additional feedback is provided.

@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 1, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
marked-website Ready Ready Preview, Comment Jun 1, 2026 3:02am

Request Review

Copy link
Copy Markdown
Member

@UziTech UziTech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 💯

@UziTech UziTech merged commit c1a86f0 into markedjs:master Jun 1, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants