lipsify
v2.0.0
Published
Random Lorem Ipsum Generator
Downloads
95
Readme
Lipsify - Random Lorem Ipsum Generator
Lipsify replaces text placeholders in your HTML templates to "Lorem Ipsum" texts. By using placeholders you can keep your demo template code short, clean and thus readable. Another benefit is that the replaced text will be random (with slightly different lenght) and thus its really easy to find places where your layout could break or look bad if there's too long or too short text.
Warning: Its not a good idea in include lipsify in production unless you know what yuore doing.
Features
- Replaces placeholders with random "Lorem Ipsum" text.
- Dynamic Content Support: Automatically replaces placeholders in content added to the DOM after initial page load (e.g., via AJAX) using a
MutationObserver. - Placeholders for one word, a phrase, one sentence, and one paragraph.
- Placeholders for an exact number of words.
- Placeholders for a random number of words.
- Attributes
href,src,action, andvalueare excluded from replacement to prevent breaking functionality.
Usage
Lipsify is distributed in the dist folder, providing both unminified and minified versions.
Direct Inclusion (UMD)
Include dist/lipsify.js or dist/lipsify.min.js directly in your HTML document.
<script src="dist/lipsify.min.js"></script>ES Module
If you are using a module bundler, you can import Lipsify as an ES module:
import 'lipsify'; // Assuming 'lipsify' resolves to 'dist/lipsify.js' or 'dist/lipsify.esm.js'
// Or directly:
import '../dist/lipsify.js';After including, write hash characters instead of text (in tag text content or attributes) as placeholders:
§- one wordConsectetur§§- a phraseSed do eiusmod tempor§§§- one sentenceUt enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.§§§§- one paragraphLorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.§3§- exact number of words In this caseLorem ipsum dolor§3§6§- random number of words In this case a phrase from 3 to 6 words
CDN
You can use Lipsify from a CDN (e.g., unpkg):
<script src="https://unpkg.com/lipsify/dist/lipsify.min.js"></script>Development
To contribute to the project:
- Fork the repository.
- Clone your fork.
- Install dependencies:
npm install - Make your changes in
src/lipsify.js. - Build the project:
npm run build - Run linting:
npm run lint - Create a new branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request.
Demo
See a live demonstration of Lipsify's features in demo/index.html.
Author
Michal Rusina
- GitHub: @michalrusina
- Email: [email protected]
- Website: https://www.michalrusina.sk
License
This project is licensed under the MIT License - see the LICENSE file for details.
