Remark utils

> Reusable utils to build markdown service power by remarkjs and elasticlunr.

[![Travis][build-badge]][build]
[![Codecov Status][codecov-badge]][codecov]
[![npm package][npm-badge]][npm]
[![npm downloads][npm-downloads]][npm]

[![prettier][prettier-badge]][prettier]
[![license][license-badge]][license]

Installation

``bash
$ yarn add remark-utils
`

Usage

$3

`js
type MdToHtml = (markdownContent: string, options: *) => string;
`

`js
import { mdToHtml } from 'remark-utils';

const html = mdToHtml('# heading');

//

heading

`js
type IndexingItem = {
title: string,
body: string,
url: string,
};

type MdToElasticlunrIndex = (
filenames: Array,
indexItemMapper: (IndexingItem, filename: string) => IndexingItem,
) => string;
`

`js
// Server side
import glob from 'glob';
import { mdToElasticlunrIndex } from 'remark-utils';
const filenames = glob.sync('path-to-md/*/.md');
const index: string = mdToElasticlunrIndex(filenames, i => i);

// Client side
import { Index } from 'elasticlunr';
const idx = Index.load(JSON.parse(index));
const results = idx
.search('query', {})
.map(({ ref }) => idx.documentStore.getDoc(ref))
.map(({ url, title, body }: IndexingItem) => ({
url,
title: highlightQuery(title),
body: highlightQuery(body),
}));
`

> Check the tests and Query from Index section for more details.

API

$3

src/utils/defaultOptions.js

Use with lazysizes

`js
// Server side preprocess
const base64Json = {
'../images/AWS_Icons-300x200.png': {
imagePath: '../images/AWS_Icons-300x200.png',
width: 300,
height: 200,
format: 'png',
base64: 'data:image/png;base64,mock',
},
};

// Mapping
const html = mdToHtml(
!AWS_Icons-300x200.png,
{
lazysizes: {
base64Mapper: (imagePath: string) => base64Json[imagePath],
srcAttr: 'data-src',
},
},
);
// Output html:


// Client side
import('lazysizes').then(({ default: lazysizes }) => {
lazysizes.init();
});
`

- https://github.com/aFarkas/lazysizes

Development

- node 11.9.0
- yarn 1.13.0

`bash
$ yarn install --pure-lockfile
`

Test

`bash
$ yarn run format
$ yarn run eslint
$ yarn run flow
$ yarn run test:watch
$ yarn run build
`

Publish

`bash
$ npm version patch
$ npm run changelog
git commit & push
``

---

CONTRIBUTING

- ⇄ Pull requests and ★ Stars are always welcome.
- For bugs and feature requests, please create an issue.
- Pull requests must be accompanied by passing automated tests.

CHANGELOG

LICENSE

[build-badge]: https://travis-ci.com/evenchange4/remark-utils.svg?branch=master
[build]: https://travis-ci.com/evenchange4/remark-utils
[npm-badge]: https://img.shields.io/npm/v/remark-utils.svg?style=flat-square
[npm]: https://www.npmjs.org/package/remark-utils
[codecov-badge]: https://img.shields.io/codecov/c/github/evenchange4/remark-utils.svg?style=flat-square
[codecov]: https://codecov.io/github/evenchange4/remark-utils?branch=master
[npm-downloads]: https://img.shields.io/npm/dt/remark-utils.svg?style=flat-square
[license-badge]: https://img.shields.io/npm/l/remark-utils.svg?style=flat-square
[license]: http://michaelhsu.mit-license.org/
[prettier-badge]: https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square
[prettier]: https://github.com/prettier/prettier