Source repository for https://ladysnake.github.io

To run the site locally, follow these steps: 0. Clone this repository - If you already installed Jekyll, skip to step 4 - If you run NixOS with Flakes enabled, run nix develop and skip to step 4

1. Install Ruby with its development headers
2. Install Bundler (requires admin rights):

   $ gem install bundler

3. Setup Jekyll (from the root of this repository, requires admin rights):

   $ bundle install
   > Fetching gem metadata from https://rubygems.org/............
   > Fetching version metadata from https://rubygems.org/...
   > Fetching dependency metadata from https://rubygems.org/..
   > Resolving dependencies...

4. Setup NPM in the svelte_sprinkles directory:

   $ npm --prefix svelte_sprinkles install

5. Start the site (from the root of this repository):

   $ bundle exec jekyll serve
   > Configuration file: /Users/octocat/ladysnake.github.io/_config.yml
   >            Source: /Users/octocat/ladysnake.github.io
   >       Destination: /Users/octocat/ladysnake.github.io/_site
   > Incremental build: disabled. Enable with --incremental
   >      Generating...
   >                    done in 0.309 seconds.
   > Auto-regeneration: enabled for '/Users/octocat/ladysnake.github.io'
   > Configuration file: /Users/octocat/ladysnake.github.io/_config.yml
   >    Server address: http://127.0.0.1:4000/
   >  Server running... press ctrl-c to stop.

6. Preview your copy of the site in your web browser at http://localhost:4000.

Dynamic Content

Build-time

This website makes use of a number of custom Jekyll plugins, most notably to dynamically generate crafting recipe widgets based on the JSON data available in our mod repositories.

Runtime

Some pages like the Blabber dialogue editor use sprinkles of dynamic content in the form of Svelte components. These sprinkles are automatically built each time you run jekyll build or jekyll serve. When working on those sprinkles, one can open a separate terminal and use the npm run watch command in the svelte_sprinkles directory.