# hipsum

> A filler text generator for Handlebars templates.

Latest version **0.2.0** (published 2013-10-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install hipsum
pnpm add hipsum
yarn add hipsum
bun add hipsum
```

## 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.2.0 |
| Published | 2013-10-06 |
| First published | 2013-09-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+9 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Marc Diethelm |
| Maintainers | marcdiethelm |
| Keywords | filler, text, placeholder, text, dummy, text, lorem, ipsum, generator, handlebars, helper, hamlet |

## Links

- npm: https://www.npmjs.com/package/hipsum
- Repository: https://github.com/MarcDiethelm/Hipsum.js
- Issues: https://github.com/MarcDiethelm/Hipsum.js/issues
- npm.io page: https://npm.io/package/hipsum

## Dependencies (1)

- [handlebars](https://npm.io/package/handlebars.md) ~1.0.12

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 0.2.0 (latest) — 2013-10-06
- 0.1.0 — 2013-09-29

## README

Hipsum.js
================

A filler text helper for Handlebars templates.

[![Build Status](https://travis-ci.org/MarcDiethelm/Hipsum.js.png?branch=master)](https://travis-ci.org/MarcDiethelm/Hipsum.js) master<br>
[![Build Status](https://travis-ci.org/MarcDiethelm/Hipsum.js.png?branch=develop)](https://travis-ci.org/MarcDiethelm/Hipsum.js) develop

## Installation

Install Hipsum.js in your project folder using a terminal.

```Bash
npm install hipsum --save
```

In your application you can then include and register the helper.

```js
var handlebars = require('handlebars'),
    require('hipsum')(handlebars);
```

## Usage

In your Handlebars templates you can now use the helper called `filler`.

```Handlebars
{{filler}} // produces one paragraph of Lorem ipsum.
{{filler 47}} // produces 47 words of Lorem ipsum.
```

### Alternate Texts

If you prefer some good ol' English why not use some Shakespeare as your filler text?

```Handlebars
{{filler 10 "hamlet"}} // produces 10 words of "To be or not to be".
```

## Advanced Setup

Alternatively you can pass the helper around and not let Hipsum.js register it. This is useful e.g. if you use
[express3-handlebars](https://github.com/ericf/express3-handlebars) or when you want to specify the name of the helper
yourself. 

```js
var handlebars = require('handlebars'),
    hipsumHelper = require('hipsum')();

handlebars.registerHelper('filler', hipsumHelper);
```

## Roadmap

- Random text generation
- Richtext
	- Paragraphs
	- Links
	- Headings, Lists, Tables, Blockquotes
	- Images(?)
	- Code(?)

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