remarkjs / Remark Defsplit
Programming Languages
Projects that are alternatives of or similar to Remark Defsplit
remark-defsplit
remark plugin to change links and images to references with separate definitions.
Install
npm:
npm install remark-defsplit
Use
Say we have the following file, example.md
.
[![Build Status](https://travis-ci.org/remarkjs/remark-defsplit.svg?branch=master)](https://travis-ci.org/remarkjs/remark-defsplit)
And our script, example.js
, looks as follows:
var vfile = require('to-vfile')
var remark = require('remark')
var defsplit = require('remark-defsplit')
remark()
.use(defsplit, {id: ['travis-badge', 'travis']})
.process(vfile.readSync('example.md'), function(err, file) {
if (err) throw err
console.log(String(file))
})
Now, running node example
yields:
[![Build Status][travis-badge]][travis]
[travis-badge]: https://travis-ci.org/remarkjs/remark-defsplit.svg?branch=master
[travis]: https://travis-ci.org/remarkjs/remark-defsplit
API
remark().use(defsplit[, options])
Change links and images to references with separate definitions.
options.id
Identifiers to use for new definitions instead of autogenerated ones (string
or Array.<String>
, default: []
).
Security
Use of remark-defsplit
does not involve rehype
(hast) or user content so there are no openings for
cross-site scripting (XSS) attacks.
Related
-
remark-reference-links
— Practically the same asremark-defsplit
, but with numeric identifiers instead of URI-based ones -
remark-inline-links
— Reverse, thus rewriting references and definitions into links and images
Contribute
See contributing.md
in remarkjs/.github
for ways
to get started.
See support.md
for ways to get help.
This project has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.
License
MIT © Eugene Sharygin