markdown-it-myst-extras
Advanced tools
Additional markdown-it plugins required for the MyST specification.
Readme
Additional markdown-it plugins required for the MyST specification.
As a Node module:
import MarkdownIt from "markdown-it"
import { mystBlockPlugin, colonFencePlugin } from "markdown-it-myst-extras"
const text = MarkdownIt().use(mystBlockPlugin).render("+++")
In the browser:
<!DOCTYPE html>
<html>
<head>
<title>Example Page</title>
<script src="https://cdn.jsdelivr.net/npm/markdown-it@12/dist/markdown-it.min.js"></script>
<script src="https://unpkg.com/markdown-it-myst-extras"></script>
</head>
<body>
<div id="demo"></div>
<script>
const text = window
.markdownit()
.use(window.markdownitMystExtra.mystBlockPlugin)
.render("+++")
document.getElementById("demo").innerHTML = text
</script>
</body>
</html>
package.jsonLICENSEREADME.mdrollup.config.jsnode_module dependencies: npm install or npm ci (see Install a project with a clean slate).npm run format, and linting: npm run lint:fix.≈, or with coverage; npm test -- --coverage.Now you can start to adapt the code in src/index.ts for your plugin, starting with the markdown-it development recommendations.
Modify the test in tests/fixtures.spec.ts, to load your plugin, then the "fixtures" in tests/fixtures, to provide a set of potential Markdown inputs and expected HTML outputs.
On commits/PRs to the main branch, the GH actions will trigger, running the linting, unit tests, and build tests.
Additionally setup and uncomment the codecov action in .github/workflows/ci.yml, to provide automated CI coverage.
Finally, you can update the version of your package, e.g.: npm version patch -m "🚀 RELEASE: v%s", push to GitHub; git push --follow-tags, build; npm run build, and publish; npm publish.
Finally, you can adapt the HTML document in docs/, to load both markdown-it and the plugin (from unpkg), then render text from an input area.
This can be deployed by GitHub Pages.
From the markdown-it development recommendations:
Plugins should not require the
markdown-itpackage as a dependency inpackage.json.
Note, for typing, we import this package with import type, to ensure the imports are not present in the compiled JavaScript.
There are a number of JavaScript unit testing frameworks (see this comparison, jest is easy to setup/use, flexible, and well used in large projects however does not currently have native support for ESM. vitest was chosen for out-of-the box compatibility with jest, however, it is both more performant and is currently easier to integrate with ESM/TypeScript packages.
The three main bundlers are; Webpack, Rollup and Parcel, with the functionality gap between all of these bundlers narrowing over the years.
Essentially, Rollup provides a middle ground between features and complexity, and is good for bundling libraries (it is what markdown-it itself uses).
See for example:
FAQs
Additional markdown-it plugins required for the MyST specification.
We found that markdown-it-myst-extras demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.