Home

Welcome to the slimeknights.github.io wiki! This wiki contains any relevant info to maintaining the https://slimeknights.github.io/ website. It does not cover documentation on the mods themselves, that belongs on the documentation.

To get started on working on the website, you will need to install Jekyll which runs off Ruby. You can find documentation for installing at https://jekyllrb.com/docs/installation/. Once installed, you can launch the website locally to test changes using the included build.bat file (if not running on a Windows you should be able to copy the commands into a terminal).

Jekyll runs on a fusion of markdown, standard HTML, JavaScript, and CSS, and the Liquid templating system. The following links may be useful:

• Posts: Covers how to create new blog posts. I often just copy and paste an existing one to get started.
• Front Matter: Contains basic information on configuring pages.
• Jekyll Liquid Filters: Describes "filters" which provide tools for generating content on pages using variables or site data.
• Liquid Filters: Describes all available "filters" from Liquid that allow generating page contents using loops, conditional, and other similar expressions.
• Includes describes how to create includes which allow templating commonly used page elements. We use these for blogpost gallery views, book pages, and JSON schema types.

We are using GitHub pages to build the site, meaning the site will automatically build and publish every time you push a commit. There is a limit to how many times we can rebuild the site per day, but I have not hit that limit before. As part of using GitHub pages, we cannot use any custom Ruby which Jekyll normally allows. Additionally, we are limited to using packages from a whitelist of pages (note the whitelist page is currently broken, it will automatically redirect you to the new docs site which is missing that info so you will need to prevent the redirect to read it).