# doxie.append

> Add a string at the end of your docs.

Latest version **0.1.0** (published 2015-07-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install doxie.append
pnpm add doxie.append
yarn add doxie.append
bun add doxie.append
```

## 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.1.0 |
| Published | 2015-07-20 |
| First published | 2015-07-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | © 2015 Studio B12 GmbH |
| Maintainers | tomekwi |
| Keywords | doxie-plugin |

## Links

- npm: https://www.npmjs.com/package/doxie.append
- Repository: https://github.com/studio-b12/doxie.append
- Homepage: https://github.com/studio-b12/doxie.append#readme
- Issues: https://github.com/studio-b12/doxie.append/issues
- npm.io page: https://npm.io/package/doxie.append

## Dependencies (1)

- [object-assign](https://npm.io/package/object-assign.md) ^3.0.0

## Recent versions

- 0.1.0 (latest) — 2015-07-20

## README

[![Coveralls – test coverage
](https://img.shields.io/coveralls/studio-b12/doxie.append.svg?style=flat-square)
](https://coveralls.io/r/studio-b12/doxie.append)
 [![Travis – build status
](https://img.shields.io/travis/studio-b12/doxie.append/master.svg?style=flat-square)
](https://travis-ci.org/studio-b12/doxie.append)
 [![David – status of dependencies
](https://img.shields.io/david/studio-b12/doxie.append.svg?style=flat-square)
](https://david-dm.org/studio-b12/doxie.append)
 [![Stability: unstable
](https://img.shields.io/badge/stability-unstable-yellowgreen.svg?style=flat-square)
](https://github.com/studio-b12/doxie.append/milestones/1.0)
 [![Code style: airbnb
](https://img.shields.io/badge/code%20style-airbnb-777777.svg?style=flat-square)
](https://github.com/airbnb/javascript)




<h1                                                                 id="/"><pre>
doxie --append
</pre></h1>

A plugin for **[doxie][]**.  
**Add a string at the end of your docs.**

[doxie]:  https://github.com/studio-b12/doxie




<p align="center"><a
  title="Graphic by the great Justin Mezzell"
  href="http://justinmezzell.tumblr.com/post/89957156723"
  >
  <br/>
  <br/>
  <img
    src="Readme/Balls.gif"
    width="400"
    height="300"
  />
  <br/>
  <br/>
</a></p>




<div                                                               >&nbsp;</div>

CLI Usage
---------

`doxie --append` is a plugin for the command-line tool **[doxie][]**. Many plugins are designed for **[dox][]** data. Install all three if you haven’t already:

```sh
$ npm install [--save-dev|--global] dox doxie doxie.append
```


Any string you `--append` will be appended at the end of your docs:

```sh
$ echo '' | dox | doxie --append 'a b c\n' --append 'def\n' --output
a b c
def
```


[dox]:                http://npm.im/dox




<div                                                               >&nbsp;</div>

Programmatic usage
------------------

`doxie.append` can be used directly with **[doxie-core][]** – the backend of **[doxie][]**. Install both if you haven’t already:

```sh
$ npm install doxie-core doxie.append
```


Pass a single string to `doxie.append` to instantiate the plugin:

```js
const doxie = require('doxie-core');
const render = require('doxie.render');
const append = require('doxie.append');
const output = require('doxie.output');

const myDoxData = [{isPrivate: true}, {isPrivate: false}, {isPrivate: false}];

doxie([
  render(({data}) => `${data.isPrivate ? 'Sshhh…' : 'Boom!'}\n`),
  append('AAAAAAA!\n'),
  output(),
])(myDoxData).output;
//» "Sshhh…\nBoom!\nBoom!\nAAAAAAA!\n"
```


[doxie-core]:  http://npm.im/doxie-core




<div                                                               >&nbsp;</div>

License
-------

[MIT][] © [Studio B12 GmbH][]

[MIT]:              ./License.md
[Studio B12 GmbH]:  http://studio-b12.de

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