UNPKG

getlorem

Version:

Generate passages of Lorem Ipsum text, suitable for use as placeholder text in documents.

113 lines (67 loc) • 2.21 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
# [getlorem](https://getlorem.com) Generate passages of Lorem Ipsum text, suitable for use as placeholder text in documents. This library can be used as a Node.js module as well as a being included as a standalone script on a page via Require.js or in a script tag. For a live demo see [getlorem.com](https://getlorem.com). ##Installing the module (Node.js) ``` npm install getlorem ``` Require getlorem and use it to generate a passage of lorem ipsum text. ``` var getlorem = require('getlorem'); var output = getlorem.paragraphs(5); ``` ##Usage ###Generating words ``` getlorem.words(5); ``` ###Generating sentences ``` getlorem.sentences(5); ``` ###Generating paragraphs ``` getlorem.paragraphs(5); ``` ###Generating lists ``` getlorem.lists(5); ``` ###Generating bytes ``` getlorem.bytes(5); ``` ##Wrapping text with HTML tags If you would like to wrap the generated text with a tag, pass it as the second parameter. ``` getlorem.paragraphs(5,'p'); // Generates: <p>Lorem ipsum...</p><p>...</p><p>...</p> ``` ## Starting with 'Lorem ipsum...' To generate a passage of text that begins with the opening 'Lorem ipsum…' sentence. Set the third parameter to true. ``` getlorem.paragraphs(4,'p',true); ``` ##Using the CLI (Node.js) getlorem can be used from the command line. To do this, install it globally. ``` npm install getlorem --global ``` Execute the statement `getlorem` to generate lorem ipsum text. ``` getlorem --units words --count 200 --copy ``` Refine the output with the following arguments. | Argument | Description | | -------- | ---------------------------------------- | | --units | Generate words, sentences, paragraphs, lists, bytes | | —count | The number of unites to be generated | | —copy | Copy to clipboard | | —tags | HTML tags to wrap the units | | —swl | Start with 'lorem ipsum...' | ##As a jQuery plugin This library can also be used as a jQuery plugin. Placing the attribute `data-getlorem` on any container element will populate that element with the assigned number of Lorem Ipsum words. ``` <div data-getlorem="50"></div> ```