# lorem-hipsum

> Generates passages of lorem hipsum text

Latest version **0.1.7** (published 2015-04-13) · MIT/X11 license · 0 weekly downloads

## Install

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

Provides the commands `hipsum`, `lorem-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.1.7 |
| Published | 2015-04-13 |
| First published | 2014-08-13 |
| Weekly downloads | 0 |
| License | MIT/X11 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Petar Bojinov |
| Maintainers | pbojinov |
| Keywords | lorem, hipsum, placeholder, text, lipsum |

## Links

- npm: https://www.npmjs.com/package/lorem-hipsum
- Repository: https://github.com/pbojinov/lorem-hipsum
- Issues: https://github.com/pbojinov/lorem-hipsum/issues
- npm.io page: https://npm.io/package/lorem-hipsum

## Dependencies (1)

- [optimist](https://npm.io/package/optimist.md) ~0.3.5

## Alternatives

- [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads
- [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads
- [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads
- [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads
- [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads

## Recent versions

- 0.1.7 (latest) — 2015-04-13
- 0.1.6 — 2015-03-18
- 0.1.5 — 2015-03-18
- 0.1.4 — 2015-03-10
- 0.1.2 — 2014-08-13
- 0.1.1 — 2014-08-13
- 0.1.0 — 2014-08-13

## README

## lorem-hipsum

> lorem-hipsum is a npm module for generating passages of lorem hipsum text. lorem hipsum text is **not** commonly used as placeholder text in publishing, graphic design, and web development, but should be.

### Why Fork?

We all love lorem ipsum but deep down inside we know it's not the [artisanal filter text](http://hipsum.co/) we really crave.

### Getting Started

Install the lorem-hipsum npm module locally in your project
```bash
npm install lorem-hipsum --save-dev
```

Require the lorem-hipsum module and use it to generate a passage of lorem hipsum text.

```javascript
var loremHipsum = require('lorem-hipsum'), 
    output = loremHipsum();
```

### Options

You can customize the output with options.

Pass the options to the `loremHipsum()` function to fine-tune the output. The API is the same programatically and on the CLI. See below: 

```javascript
var loremHipsum = require('lorem-hipsum'), 
    output = loremHipsum();

output = loremHipsum({
  count: 1,                      // Number of words, sentences, or paragraphs to generate.
  units: 'sentences',            // Generate words, sentences, or paragraphs.
  sentenceLowerBound: 5,         // Minimum words per sentence.
  sentenceUpperBound: 15,        // Maximum words per sentence.
  paragraphLowerBound: 3,        // Minimum sentences per paragraph.
  paragraphUpperBound: 7,        // Maximum sentences per paragraph.
  format: 'plain',               // Plain text or html
  words: ['ad', 'dolor', ... ],  // Custom word dictionary. Uses dictionary.words (in lib/dictionary.js) by default.,
  random: Math.random,           // A PRNG function. Uses Math.random by default
});
```

### Using it globally from the CLI

lorem-hipsum includes a command line interface for generating passages of lorem hipsum text. Install the module globally to take advantage of this feature.

```bash
npm install lorem-hipsum --global
```

Execute the statement `lorem-hipsum` from your terminal to generate a passage of lorem hipsum text. You can pass arguments to the program to fine-tune the output.

```bash
lorem-hipsum --units words --count 100 --copy
```

Or using the shorthand way to easily copy a sentence to your clipboard.

```bash
hipsum  --copy
```

See below for a description of the arguments to the program.

<table>
  <tr>
    <th>Argument</th>
    <th>Description</th>
  </tr>
  <tr>
    <td>--count</td>
    <td>The <strong>number</strong> of words, sentences or paragraphs to generate</td>
  </tr>
  <tr>
    <td>--units</td>
    <td>Generate <strong>words</strong>, <strong>sentences</strong> or <strong>paragraphs</strong></td>
  </tr>
  <tr>
    <td>--copy</td>
    <td><strong>Copy</strong> the output to the system clipboard</td>
  </tr>
  <tr>
    <td>--format</td>
    <td><strong>html</strong> or <strong>plain</strong> text format</td>
  </tr>
</table>

You may now also use a short form when running lorem hipsum from the command line. Here's some examples:

```
lorem-hipsum 1 word
```

```
lorem-hipsum 15 sentences --copy
```

```
lorem-hipsum 5 paragraphs --copy --format html
```

### Shoutouts

Special thanks for [@boohah](https://github.com/boogah) for doing a dump of the [http://hipsum.co](http://hipsum.co) database on his [gist](https://gist.github.com/boogah/2e880e0f99823a84f61d)

To [@hipsum_](https://twitter.com/hipsum_) for the artisanal corpus.

And to [@knicklabs](https://github.com/knicklabs) for all of the heavy lifting and original module.

### License

This software is licensed under the MIT license.

Copyright (c) 2015 Petar Bojinov

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