weaponsforge/hili-lipsum repository overview

⁠hili-lipsum

Hilichurlian language lorem ipsum generator.

It has methods for web-scraping data from the https://genshin-impact.fandom.com/wiki/Hilichurlian/Lexicon⁠ Wiki.

GitHub Repository
https://github.com/weaponsforge/hili-lipsum⁠

NPM Registry
https://www.npmjs.com/package/hili-lipsum⁠

⁠Usage

1. Pull the "latest" local development image.
   docker pull weaponsforge/hili-lipsum:latest

2. Run the development image.
   docker run -it --rm -d --name weaponsforge-hili-lipsum weaponsforge/hili-lipsum:latest sh

3. Run available scripts in the development image.
   docker exec -it weaponsforge-hili-lipsum <SCRIPT_NAME>

4. To enable running the npm run scrape script, spin up the container with:
   docker run -it --rm -d --name weaponsforge-hili-lipsum -e HILICHURLIAN_TEXT_URL=https://genshin-impact.fandom.com/wiki/Hilichurlian/Lexicon weaponsforge/hili-lipsum:latest sh

5. Stop the container.
   docker stop weaponsforge-hili-lipsum

---

⁠Available Scripts

⁠npm run scrape

Download, scrape and format hilichurlian words from the reference URL by default. Writes the extracted and formatted words into a hilichurlianDB-<TIMESTAMP>.json file.

⁠npm run hipsum

Generates a random lorem ipsum-like Hilichurlian sentence (max 15 words).

⁠npm run scrape:debug

Sets the IS_DOCKER=true environment variable before running the npm run scrape script to enable debugging with VSCode inside a container.