Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/diegofelipece/mussum-ipsum
JS/TS Lorem Ipsum generator
https://github.com/diegofelipece/mussum-ipsum
dummy-text javascript lorem-ipsum lorem-ipsum-generator mussum-ipsum typescript
Last synced: 15 days ago
JSON representation
JS/TS Lorem Ipsum generator
- Host: GitHub
- URL: https://github.com/diegofelipece/mussum-ipsum
- Owner: diegofelipece
- License: mit
- Created: 2015-04-14T01:10:25.000Z (over 9 years ago)
- Default Branch: develop
- Last Pushed: 2023-06-01T17:13:13.000Z (over 1 year ago)
- Last Synced: 2024-10-27T09:04:27.469Z (18 days ago)
- Topics: dummy-text, javascript, lorem-ipsum, lorem-ipsum-generator, mussum-ipsum, typescript
- Language: TypeScript
- Homepage: http://mussumipsum.com
- Size: 4.35 MB
- Stars: 174
- Watchers: 3
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# mIpsum
This is a Javascript Lorem Ipsum generator, created for [mussumipsum.com](http://mussumipsum.com), a brazilian dummy text generator. You can use it to develop anything that concerns Mussum Ipsum (like a plugin for Sublime or Atom or whatever), or to create your own customized Lorem Ipsum.
____
Add it to your project using **NPM**:
``` bash
npm install mipsum --save
```
Since `v2.3.2` it can be also imported as a module. Example:
``` javascript
import { mIpsum } from 'mipsum'
const myLoremIpsum = mIpsum({
pNum: 1,
resultType: 'text',
})
```
You can also just download the code, add **mipsum.min.js** to your project and call it on your JS.
``` html
```
mIpsum was created using vanilla Javascript, to allow you to decide if you want to include it in any context, some use examples:
#### vanilla JS
``` javascript
const mussumIpsum = mIpsum({ pNum: 10 }); // Put how many paragraphs you want
document.querySelector('body').innerHtml = mussumIpsum;
```
#### the same thing with jQuery
``` javascript
const mussumIpsum = mIpsum({ pNum: 10 });
$('body').append(mussumIpsum);
```
There are other customized options available to you. More examples at **demo/**
### Options
Key | Type | Default | Description
--- | --- | --- | ---
pNum | Number | `1` | Number of paragraphs requested
quotes | Array | `mussumQuotes` | Array of quotes to generate paragraphs
mainQuote | String | `mussumMainQuote` | Main quote to start your "Lorem Ipsum"
genLimit | Number | `1000` | Limit of paragraphs that can be requested
resultType | String | `html` | Format of the response, choose between: `html`, `text` or `array`
tagBefore | String | `
` | Anything you want to put before each paragraph (valid only with `html` resultType)
tagAfter | String | `
` | Anything you want to put after each paragraph (valid only with `html` resultType)
pQuotes | Number | `4` | Number of quotes used to build a paragraph
The options can be set on an object passed as a parameter, like the example below:
``` javascript
mIpsum({
pNum: 1,
quotes: [
'Hi, my name is, what?',
'My name is, who?',
'Hi, my name is, huh?',
'My name is, chka-chka',
],
mainQuote: 'Slim Shady',
genLimit: 1000,
resultType: 'html',
tagBefore: '
',
tagAfter: '
',
pQuotes: 4
});
```
___
## To contribute
Fork the repository, fork and clone it on your local folder. Create your `feature/` branch from `develop`.
To start developing, just run `npm install` to install all packages (last time we used Node v13.13.0), and then you need to run two cmds:
- `npm run build` (or `npm run build -- --watch`) that should build
- `npm start` should launch a live demo at your `http://localhost:8080`
____
## Related Projects
- [Mussum Ipsum REST API](https://github.com/wilkerHop/mussum-ipsum-api)
____
Created by [Diego Esteves](http://diegoesteves.ink) under The MIT License (MIT)