remark-code-titles

Remark plugin to add title to code block

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
remark-code-titles
1640.1.23 years ago5 years agoMinified + gzip package size for remark-code-titles in KB

Readme

remark-code-titles
npm version
Remark plugin to add code title inspired by gatsby-remark-code-titles

Usage

We have the following file, hello.md:
~markdown
Hello World
```js:hello.js console.log('js')
~~~

And our script, `hello.js`, lokks as follows:

```js:sample.js
const vfile = require('to-vfile')
const unified = require('unified')
const parse = require('remark-parse')
const codeTitle = require('remark-code-titles')
const html = require('remark-html')

const result = unified()
  .use(parse)
  .use(codeTitle)
  .use(html)
  .process(vfile.readSync('./hello.md'), (err, file) => {
    if (err) throw err
    console.log(String(file))
  })

Now, running node hello.js yields:
<h1>Hello World</h1>
<div class="remark-code-title">hello.js</div>
<pre><code class="language-js">console.log('js')
</code></pre>