
Security News
TypeScript is Porting Its Compiler to Go for 10x Faster Builds
TypeScript is porting its compiler to Go, delivering 10x faster builds, lower memory usage, and improved editor performance for a smoother developer experience.
@hashicorp/remark-plugins
Advanced tools
A potpourri of remark plugins used to process .mdx files
Deprecated: This repository has been archived, our remark plugins now live at hashicorp/web-platform-packages
A potpourri of remark plugins used by HashiCorp to process markdown files.
MDX uses remark internally to process and transform markdown via plugins. We use MDX to process markdown content to build out our docs, learning guides, and write rich content from our CMS. This set of plugins ensures that written markdown is translated properly into markup.
The anchorLinks
plugin adds anchor links to headings and when a list begins with an inline code
element so that users are able to easily link to a specific place even if it is further down the page. See its readme for more details.
The includeMarkdown
plugin gives authors the ability to use a directive like `@include "filename.md" to import markdown from a separate file, like a partial. See its readme for more details.
The paragraphCustomAlerts
plugin adds a custom syntax for creating alert boxes. See its readme for more details. This plugin will be deprecated for a <Alert />
component in the future in a step to move us toward full commonmark compliance.
The typography
plugin adds css classes to certain typographical elements so that they adhere to the typography standards from our design system. See its readme for more details.
Each of the plugins are individually exposed from the default export from this module and can be used as any other remark plugin would be normally. For example, with raw mdx:
const mdx = require('@mdx-js/mdx')
const {typography, anchorLinks} = require('@hashicorp/remark-plugins')
console.log(mdx.sync('some markdown content', {
remarkPlugins: [typography, anchorLinks]
})
If you'd like to use all of the plugins in one shot, which is typically the case with this module, an array of all the plugins is returned from the allPlugins
export, as such:
const mdx = require('@mdx-js/mdx')
const {allPlugins} = require('@hashicorp/remark-plugins')
console.log(mdx.sync('some markdown content', {
remarkPlugins: allPlugins(/* options */)
})
Plugin options can be passed to allPlugins
as an object, with the keys being plugin names. For example, to pass options to headingLinkable
, you could call allPlugins({ headingLinkable: { foo: 'bar' } })
.
If you are using next-hashicorp
, all of these plugins will be included by default.
To publish this package to npm, simply run npm run publish
. This command will guide you through the versioning/publishing process.
Note: There is no build step when publishing this library. The consumer is expected to transpile the code appropriately.
FAQs
A potpourri of remark plugins used to process .mdx files
We found that @hashicorp/remark-plugins demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 30 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.
Security News
TypeScript is porting its compiler to Go, delivering 10x faster builds, lower memory usage, and improved editor performance for a smoother developer experience.
Research
Security News
The Socket Research Team has discovered six new malicious npm packages linked to North Korea’s Lazarus Group, designed to steal credentials and deploy backdoors.
Security News
Socket CEO Feross Aboukhadijeh discusses the open web, open source security, and how Socket tackles software supply chain attacks on The Pair Program podcast.