lipsum-nvim

A (more or less) simple Lorem Ipsum generation plugin.

Originally created by Stewie410, whose repo is no longer available.

✨ Features

• Use either preset or user-defined word lists for generation
• Generate one or more words, lines/sentences or paragraphs
• Customize generator command names

⚠️ Requirements

• Neovim version 0.10.0 or higher
  • Only tested on v0.10, may work on older versions

📦 Installation

💤 lazy.nvim

lua { "aurelberra/lipsum-nvim", cmd = { "LipsumWord", "LipsumLine", "LipsumParagraph", }, opts = {}, }

🚐 mini.deps

lua local deps = require("mini.deps") deps.add({ source = "aurelberra/lipsum-nvim", })

📝 Configuration

lua require("lipsum-nvim").setup({ ---@type string[] List of words used for generation, will be merged with lipsum-nvim.Options.word_list words = {}, ---@type 'cicero'|'english'|'letraset'|'lipsum'|'proust'|'standard'|nil Preset word list word_list = "standard", ---@type decimal Chance to insert a comma after a word comma_chance = 0.2, ---@type decimal Chance to insert a semicolon after a word semicolon_chance = 0.05, ---@type number[] Min/Max number of words per line line_len = { 5, 12 }, ---@type number[] Min/Max number of lines per paragraph paragraph_len = { 5, 20 }, ---@type table<string, string|nil> Create generation commands, set to nil to disable the command user_commands = { ---@type string|nil Command to generate word(s), set to nil to disable words = "LipsumWord", ---@type string|nil Command to generate line(s), set to nil to disable lines = "LipsumLine", ---@type string|nil Command to generate paragraph(s), set to nil to disable paragraphs = "LipsumParagraph", }, })

The preset word lists are the following:

• standard: a very common list of 63 unique, mostly Latin words, based on fragments of Cicero’s De finibus bonorum et malorum, with 12 characters added (see the “Lorem Ipsum” Wikipedia article)
• lipsum: a common list of 293 unique, loosely Latin-looking, sometimes longer words extending the standard form
• letraset: a list of 155 unique loosely Latin-looking or English words used in the 1970s Letraset sample sheets which popularised the practice of Lorem Ipsum placeholder texts (quoted in this scholarly blog post demonstrating that it is the source of the standard version, using the same edition of Cicero’s text)
• cicero: a list of 182 unique Latin words
• english: a list of 185 unique English words
• proust: a list of 204 unique French words, derived from the opening paragraphs of Marcel Proust’s À la recherche du temps perdu

⌨️ Commands

Command names can be customized in the setup options, but by default:

• LipsumWord [num]: generate random word(s) from word list
• LipsumLine [num]: generate random line(s)/sentence(s) from word list
• LipsumParagraph [num]: generate random paragraph(s) from word list

Each command will always generate at least 1 item.

Word Generation

Words generated with lipsum.com, based on the following options:

• 100,000 words
• Start with “Lorem ipsum dolor sit amet” enabled

Once produced, filtered the results with some shellscript:

bash tr -d '\n[:punct:]' < lorem.txt | \ tr '[:upper:] ' '[:lower:]\n' | \ awk '!seen[$0]++ { printf "\t\"%s\",\n", $1 }' | \ sort

While this may not produce every possible word from the generator, on average this produces around 300 unique words, which should be sufficient.

To add your own custom words:

bash require("lipsum-nvim").setup({ words = { -- words }, })

Links

• derktata/lorem.nvim
• mbpowers/lorem-nvim
• lipsum.com