nepali-lorem-ipsum
Version:
A lightweight Lorem Ipsum generator for Nepali placeholder text in Devanagari script. Perfect for mocking up UI designs, testing fonts, or generating content for Nepali-language applications.
127 lines (84 loc) • 4.03 kB
Markdown
# nepali-lorem-ipsum 🇳🇵
A lightweight Lorem Ipsum generator for Nepali placeholder text in Devanagari script. Perfect for mocking up UI designs, testing fonts, or generating content for Nepali-language applications.
[](https://www.npmjs.com/package/nepali-lorem-ipsum)
[](https://opensource.org/licenses/MIT)
[](https://www.npmjs.com/package/nepali-lorem-ipsum)
## Features ✨
- Generate placeholder text in **Nepali (Devanagari)**.
- Customize paragraphs, sentences, and word counts.
- CLI support for terminal usage.
- TypeScript-friendly with built-in types.
- Efficient and bias-free word shuffling (Fisher-Yates algorithm).
## Installation 📦
```bash
npm install nepali-lorem-ipsum
# or
yarn add nepali-lorem-ipsum
```
## Usage 🚀
### In Code
#### JavaScript/TypeScript:
```javascript
import { getNepaliLorem } from "nepali-lorem-ipsum";
// Generate 2 paragraphs, 3 sentences each, 10 words per sentence
const placeholderText = getNepaliLorem({
paragraphs: 2,
sentencesPerParagraph: 3,
wordsPerSentence: 10,
});
console.log(placeholderText);
```
#### CommonJS:
```javascript
const { getNepaliLorem } = require("nepali-lorem-ipsum");
console.log(getNepaliLorem()); // Default: 3 paragraphs
```
### CLI
Run directly from your terminal:
```bash
npx nepali-lorem-ipsum --paragraphs 2 --sentences 4 --words 12
```
**CLI Options**:
| Flag | Description | Default |
|---------------------|--------------------------|---------|
| `-p, --paragraphs` | Number of paragraphs | `3` |
| `-s, --sentences` | Sentences per paragraph | `5` |
| `-w, --words` | Words per sentence | `15` |
## API Reference 📖
### `getNepaliLorem(options?: LoremOptions): string`
Generates Nepali placeholder text.
**Parameters**:
```typescript
interface LoremOptions {
paragraphs?: number; // Default: 3
sentencesPerParagraph?: number; // Default: 5
wordsPerSentence?: number; // Default: 15
}
```
### `getSentence(wordCount: number = 15): string`
Generates a single sentence with the specified word count.
## Sample Output 📄
```
राम्रो सुन्दर विश्व प्रकृति मन जीवन कथा भाषा विज्ञान कला इतिहास समाज साहित्य शिक्षा संस्कृति वातावरण यात्रा अनुभव सपना उद्देश्य प्रगति सुविधा समस्या समाधान परिवर्तन।
सुन्दर विश्व प्रकृति मन जीवन कथा भाषा विज्ञान कला इतिहास समाज साहित्य शिक्षा संस्कृति वातावरण यात्रा अनुभव सपना उद्देश्य प्रगति सुविधा समस्या समाधान परिवर्तन राम्रो।
```
## Contributing 🤝
Contributions are welcome!
1. Fork the [GitHub repository](https://github.com/mukundaparajuli/nepali-lorem-ipsum).
2. Create a feature branch: `git checkout -b feat/amazing-feature`.
3. Commit changes: `git commit -m 'Add amazing feature'`.
4. Push to the branch: `git push origin feat/amazing-feature`.
5. Open a pull request.
## License 📄
This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.
## Why Use This? 🌟
- **Cultural Relevance**: Replace Latin placeholder text with Nepali for authentic mockups.
- **Developer Experience**: Simple API and CLI for quick integration.
- **Performance**: Optimized shuffling and caching for fast text generation.