http-server-md/README.md

A configurable HTTP server that serves markdown files rendered to HTML with markdown-it

# A configurable HTTP server that serves markdown files rendered to HTML with [**markdown-it**][markdown-it-url]

> **http-server-md**

[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Downloads Stats][npm-downloads]][npm-url]

> README & DOCS TODO

## Installation

![npm badge][npm-badge-url]

```bash
pnpm add -g http-server-md
```

### [Developing](#developing)

```bash
pnpm gen-readme // update README.md
pnpm docs // update DOCUMENTATION.md
pnpm test // lint & mocha
pnpm update-deps // bump all deps
```

## API Reference

The standalone JSDoc-generated documentation can be found in
[**DOCUMENTATION.md**](/DOCUMENTATION.md).

## Release History

See [**CHANGELOG.md**](/CHANGELOG.md) for more information.

## License

Distributed under the **MIT** license. See [**LICENSE.md**](/LICENSE.md) for
more information.

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

[npm-image]: https://img.shields.io/npm/v/http-server-md.svg?style=flat-square
[npm-url]: https://npmjs.org/package/http-server-md
[npm-downloads]: https://img.shields.io/npm/dm/http-server-md.svg?style=flat-square
[npm-badge-url]: https://nodei.co/npm/http-server-md.png?downloads=true&downloadRank=true&stars=true
[travis-image]: https://img.shields.io/travis/f3rno64/http-server-md/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/f3rno64/http-server-md
[markdown-it-url]: https://github.com/markdown-it/markdown-it