# marked-own

> Markdown publishing server

Latest version **0.0.1-alpha** (published 2016-02-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install marked-own
pnpm add marked-own
yarn add marked-own
bun add marked-own
```

Provides the command `mo`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1-alpha |
| Published | 2016-02-25 |
| First published | 2016-02-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | 59naga |
| Maintainers | 59naga |
| Keywords | markdown, cms, blog |

## Links

- npm: https://www.npmjs.com/package/marked-own
- Repository: https://github.com/59naga/marked-own
- Homepage: https://github.com/59naga/marked-own#readme
- Issues: https://github.com/59naga/marked-own/issues
- npm.io page: https://npm.io/package/marked-own

## Dependencies (9)

- [jade](https://npm.io/package/jade.md) ^1.11.0
- [marked](https://npm.io/package/marked.md) ^0.3.5
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [stylus](https://npm.io/package/stylus.md) ^0.53.0
- [cheerio](https://npm.io/package/cheerio.md) ^0.20.0
- [express](https://npm.io/package/express.md) ^4.13.4
- [bluebird](https://npm.io/package/bluebird.md) ^3.3.1
- [commander](https://npm.io/package/commander.md) ^2.9.0
- [kouto-swiss](https://npm.io/package/kouto-swiss.md) ^0.11.14

## 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

- 0.0.1-alpha (latest) — 2016-02-25
- 0.0.0 — 2016-02-22
- 0.0.0-alpha — 2016-02-22

## README

Marked-own
---

<p align="right">
  <a href="https://npmjs.org/package/marked-own">
    <img src="https://img.shields.io/npm/v/marked-own.svg?style=flat-square">
  </a>
  <a href="https://travis-ci.org/59naga/marked-own">
    <img src="http://img.shields.io/travis/59naga/marked-own.svg?style=flat-square">
  </a>
  <a href="https://codeclimate.com/github/59naga/marked-own/coverage">
    <img src="https://img.shields.io/codeclimate/github/59naga/marked-own.svg?style=flat-square">
  </a>
  <a href="https://codeclimate.com/github/59naga/marked-own">
    <img src="https://img.shields.io/codeclimate/coverage/github/59naga/marked-own.svg?style=flat-square">
  </a>
</p>

> (WIP) Markdown publishing server.

CLI
---

```bash
npm install marked-own --global
```

# `mo` Command

```md
<!-- index.md -->
**Hello marked-own**

```

```bash
tree .

# .
# └── index.md
mo
#  ______              _             _
# |  ___ \            | |           | |
# | | _ | | ____  ____| |  _ ____ _ | |___ ___  _ _ _ ____
# | || || |/ _  |/ ___) | / ) _  ) || (___) _ \| | | |  _ \
# | || || ( ( | | |   | |< ( (/ ( (_| |  | |_| | | | | | | |
# |_||_||_|\_||_|_|   |_| \_)____)____|   \___/ \____|_| |_|
#
#                 http://localhost:59798
curl "http://localhost:59798" # or "http://localhost:59798/index"
# <p><strong>Hello marked-own</strong></p>
```

`mo --help` check the list of options.

API
---

```bash
npm install marked-own --save
```

## markedOwn(cwd) -> middleware

Response the compiled html if the `.md` matches the `req.url`.

```bash
tree .

# .
# └── index.md
babel-node server.js
# boot on http://localhost:59798
curl "http://localhost:59798" # or "http://localhost:59798/index"
# <p><strong>Hello marked-own</strong></p>
```

```js
// server.js
import express from 'express';
import markedOwn from 'marked-own';

const port = 59798;

const app = express();
app.use(markedOwn(__dirname));
app.listen(port, () => {
  console.log(`boot on http://localhost:${port}`);
});
```

Test
---
```bash
git clone https://github.com/59naga/marked-own.git
cd marked-own

npm install
npm test
```

License
---
[MIT](http://59naga.mit-license.org/)

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