# koa-static-markdown

> a static server for markdown file relies

Latest version **1.0.1** (published 2017-12-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install koa-static-markdown
pnpm add koa-static-markdown
yarn add koa-static-markdown
bun add koa-static-markdown
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2017-12-17 |
| First published | 2017-12-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | xuxiaoyu2010@gmail.com |
| Maintainers | xuxiaoyu |
| Keywords | koa, static, markdown |

## Links

- npm: https://www.npmjs.com/package/koa-static-markdown
- Repository: https://github.com/xuxiaoyu2010/koa-static-markdown
- Homepage: https://github.com/xuxiaoyu2010/koa-static-markdown#readme
- Issues: https://github.com/xuxiaoyu2010/koa-static-markdown/issues
- npm.io page: https://npm.io/package/koa-static-markdown

## Dependencies (1)

- [ejs](https://npm.io/package/ejs.md) ^2.5.7

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2017-12-17
- 1.0.0 — 2017-12-11

## README

# koa-static-markdown
[![NPM version][npm-image]][npm-url]

An static resource server in koa, which transform markdown file to html. It let you get html file directly when you visit the markdown file in the static directory you specified in config.

## Installation

 requires __node v7.6.0__ 

```
$ npm install koa-static-markdown
```

## Example

```js
const Koa = require('koa');
const app = new Koa();
const server = require('koa-static-markdown')

app.use( server({path:'/doc',
    root:'./static',
    css:"http://example.com/markdown.css"}) );

app.listen(3000);
```



# License

  MIT

[npm-image]: https://img.shields.io/npm/v/koa-static-markdown.svg?style=flat
[npm-url]: https://www.npmjs.com/package/koa-static-markdown

---
_Source: https://npm.io/package/koa-static-markdown · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._