a8dc412b1e
Technically this makes me a Contributor according to GH ;) LOL j/k I do what I can when I can. :)
<!--
If release PR, add ?template=release.md to the PR url to use the release PR template.
If badging PR, add ?template=badges.md to the PR url to use the badges PR template.
Otherwise, you are stating this PR fixes an issue that has been submitted; or,
describes the issue or proposal under consideration and contains the project-related code to implement.
-->
**Marked version:**
0.3.19
<!-- The NPM version or commit hash having the issue -->
**Markdown flavor:** Markdown.pl|CommonMark|GitHub Flavored Markdown|n/a
GitHub Flavored Markdown *(Perhaps CommonMark down the line)*
## Description
- Fixes the request at https://github.com/markedjs/marked/issues/1232#issuecomment-382747699 <!-- (if fixing a known issue; otherwise, describe issue using the following format) -->
<!--
If no issue exists that you're aware of. The maintainers should be able to figure out if it's a duplicate.
-->
## Expectation
<!--
Describe the output you are expecting from marked
-->
GitHub Flavoured Markdown of course.
## Result
<!--
Describe the output you received from marked
-->
Continued, awesome, markdown for > ~9437 users ... denoted.
## What was attempted
<!--
Describe what code combination got you there
-->
A subtle, indirect, request for Usership addition in a comment. :) Hopefully I got the badge of honour correct.
## 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.
- [ ] Draft GitHub release notes have been updated.
- [ ] CI is green (no forced merge required).
- [ ] Merge PR
- About
- Demo
- Installation
- Usage
- Supported Markdown specifications
- Security
- Contributing
- Authors
- License
Marked
Marked is
- built for speed.*
- a low-level markdown compiler for parsing markdown without caching or blocking for long periods of time.**
- light-weight while implementing all markdown features from the supported flavors & specifications.***
- available as a command line interface (CLI) and running in client- or server-side JavaScript projects.
* Still working on metrics for comparative analysis and definition.
** As few dependencies as possible.
*** Strict compliance could result in slower processing when running comparative benchmarking.
Demo
Checkout the demo page to see marked in action ⛹️
These documentation pages are also rendered using marked 💯
Installation
CLI: npm install -g marked
In-browser: npm install marked --save
Usage
CLI
$ marked -o hello.html
hello world
^D
$ cat hello.html
<p>hello world</p>
$ marked -s "*hello world*"
<p><em>hello world</em></p>
Browser
<!doctype html>
<html>
<head>
<meta charset="utf-8"/>
<title>Marked in the browser</title>
</head>
<body>
<div id="content"></div>
<script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
<script>
document.getElementById('content').innerHTML =
marked('# Marked in browser\n\nRendered by **marked**.');
</script>
</body>
</html>
Marked offers advanced configurations and extensibility as well.
Supported Markdown specifications
We actively support the features of the following Markdown flavors.
| Flavor | Version |
|---|---|
| The original markdown.pl | -- |
| CommonMark | 0.28 |
| GitHub Flavored Markdown | 0.28 |
By supporting the above Markdown flavors, it's possible that Marked can help you use other flavors as well; however, these are not actively supported by the community.
Security
The only completely secure system is the one that doesn't exist in the first place. Having said that, we take the security of Marked very seriously.
Therefore, please disclose potential security issues by email to the project committers as well as the listed owners within NPM. We will provide an initial assessment of security reports within 48 hours and should apply patches within 2 weeks (also, feel free to contribute a fix for the issue).
Contributing
The marked community enjoys a spirit of collaboration and contribution from all comers. Whether you're just getting started with Markdown, JavaScript, and Marked or you're a veteran with it all figured out, we're here to help each other improve as professionals while helping Marked improve technically. Please see our contributing documentation for more details.
For our Contribution License Agreement, see our license.
Authors
For list of credited authors and contributors, please see our authors page.
License
Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License)
See license for more details.