{"repo":"metalsmith/markdown","free":true,"listed":false,"github":"https://github.com/metalsmith/markdown","clone":"git clone https://github.com/metalsmith/markdown.git","description":"A metalsmith plugin to render markdown files to HTML.","language":"JavaScript","stars":62,"topics":["metalsmith","metalsmith-plugin","markdown"],"license":"MIT","category":"productivity","readme_excerpt":"@metalsmith/markdown A Metalsmith plugin to render markdown files to HTML, using Marked (by default). [![metalsmith: core plugin][metalsmith-badge]][metalsmith-url] [![npm: version][npm-badge]][npm-url] [![ci: build][ci-badge]][ci-url] [![code coverage][codecov-badge]][codecov-url] [![license: MIT][license-badge]][license-url] Features - Compiles .md and .markdown files in metalsmith.source() to HTML. - Enables rendering file or metalsmith metadata keys to HTML through the keys option - Define a dictionary of markdown globalRefs (for links, images) available to all render targets - Supports using the markdown library of your choice through the render option Installation NPM: Yarn: Usage @metalsmith/markdown is powered by Marked (by default), and you can pass any of the Marked options to it, including the 'pro' options: renderer , tokenizer , walkTokens and extensions . @metalsmith/markdown provides the following options: - keys : Key names of file metadata to render to HTML in addition to its contents - can be nested key paths - wildcard (default: false ) - Expand wildcards in keys option keypaths - globalRefs - An object of { refname: 'link' } pairs that will be available for all markdown files and keys, or a metalsmith.metadata() keypath containing such object - render - Specify a custom render function with the signature (source, engineOptions, context) = string . context is an object with the signature { path:string, key:string } where the path key contains the current fi","default_branch":null,"files":null,"tree":[],"storefront":"/r/metalsmith","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/metalsmith/markdown/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}