# node-pluma

> quick and easy blog module, using markdown, pug, whatever

Latest version **1.0.2** (published 2018-08-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-pluma
pnpm add node-pluma
yarn add node-pluma
bun add node-pluma
```

## 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.2 |
| Published | 2018-08-18 |
| First published | 2018-07-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 6.0.0 |
| Dependencies | 10 |
| Unpacked size | 414.1 KB |
| Known vulnerabilities | 0 (+7 in 3 direct dependencies) |
| Install scripts | no |
| Author | Manuel Escudero |
| Maintainers | jmlevick |
| Keywords | blog, blogging, markdown, pug, posts, writing |

## Links

- npm: https://www.npmjs.com/package/node-pluma
- Repository: https://github.com/jmlevick/pluma
- Homepage: https://github.com/jmlevick/pluma#readme
- Issues: https://github.com/jmlevick/pluma/issues
- npm.io page: https://npm.io/package/node-pluma

## Dependencies (10)

- [pug](https://npm.io/package/pug.md) ^2.0.3
- [when](https://npm.io/package/when.md) ^3.7.8
- [lodash](https://npm.io/package/lodash.md) ^4.17.10
- [marked](https://npm.io/package/marked.md) ^0.4.0
- [fs-then](https://npm.io/package/fs-then.md) ^0.2.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.0
- [fancy-log](https://npm.io/package/fancy-log.md) ^1.3.2
- [front-matter](https://npm.io/package/front-matter.md) ^2.3.0
- [highlight.js](https://npm.io/package/highlight.js.md) ^9.12.0
- [json-front-matter](https://npm.io/package/json-front-matter.md) ^1.0.0

## Recent versions

- 1.0.2 (latest) — 2018-08-18
- 1.0.1 — 2018-08-18
- 1.0.0 — 2018-07-29

## README

![The Pluma Logo](https://spideroak.com/share/NRSXM2LDNM/CDN/home/levick/P%C3%BAblico/CDN/mercury-8011/pluma.svg)

# Pluma

[![Build Status](https://travis-ci.org/jmlevick/pluma.svg?branch=master)](https://travis-ci.org/jmlevick/pluma)

***NOTE:** Pluma is a fork of the famous nodeJS blogging platform "Poet" from [jsantell][1].*

Pluma has your code-blogging back. Renders markdown, pug, or any templated files as posts, tag it up with metadata that's passed into any view engine you want, instant pagination, tag and category views, and home in time for dinner.

## Support

Check the [CHANGELOG.md](https://github.com/jmlevick/pluma/blob/master/CHANGELOG.md) for more information about support concerns.

## Documentation (TO-DO)

Full documentation for *Poet* (Pluma's forked project) can be found at [https://jsantell.github.io/poet](https://jsantell.github.io/poet)

## Installing

* `yarn add node-pluma@version`

## Setup

Include Pluma in your **package.json** and add it to your app, passing in your Express app and options as arguments. Call the `init` method and routes will be set up!

```javascript
const express = require('express');
const app = express();
const Pluma = require('node-pluma');

const pluma = Pluma(app, {
  posts: './_posts/',
  postsPerPage: 5,
  metaFormat: 'json'
});

pluma.init().then( () => {
  // ready to go!
});

/* set up the rest of the express app */
```

## Development

To run tests, run `yarn test` from the project root to run the Mocha tests. Generate documentation by updating the `docs.md` and running `make`.

## Contributing

Please read the [CONTRIBUTING.md](https://github.com/jmlevick/pluma/blob/master/CONTRIBUTING.md) for guides on contributions.

## Licenses

 * **Poet:** MIT License, Copyright (c) 2012 Jordan Santell
 * **Pluma:** MIT License, Copyright (c) 2018 Manuel Escudero

  [1]: https://github.com/jsantell

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