Install, Configure JustTheDocs

.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: /
+    schedule:
+      interval: daily
+    allow:
+      - dependency-type: direct

.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3' # Not needed with a .ruby-version file
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+          cache-version: 0 # Increment this number if you need to re-download cached gems
+      - name: Build with Jekyll
+        run: bundle exec jekyll build

.github/workflows/pages.yml

@@ -9,8 +9,6 @@ name: Deploy Jekyll site to Pages
 on:
   push:
     branches: ["main"]
-    paths:
-      - "docs/**"
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -30,9 +28,6 @@ jobs:
   # Build job
   build:
     runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: docs
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -42,7 +37,6 @@ jobs:
           ruby-version: '3.3' # Not needed with a .ruby-version file
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
           cache-version: 0 # Increment this number if you need to re-download cached gems
-          working-directory: '${{ github.workspace }}/docs'
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v5
@@ -54,8 +48,6 @@ jobs:
       - name: Upload artifact
         # Automatically uploads an artifact from the './_site' directory by default
         uses: actions/upload-pages-artifact@v3
-        with:
-          path: "docs/_site/"
 
   # Deployment job
   deploy:

.vscode/settings.json

@@ -1,6 +1,7 @@
 {
     "cSpell.words": [
         "Bepin",
+        "callouts",
         "colour",
         "Klux",
         "Kofi",

docs/Choosing-A-License.md → Guides/Choosing-A-License.md

@@ -1,8 +1,13 @@
+---
+title: Choosing a License
+parent: Guides
+---
+
 # Choosing a License
 
 Hey, so you've made a mod, great job! But now you're stumped: Which license do I choose? Here are some suggestions from the Lethal Company Modding Community. Make sure you understand any license you select fully.
 
-> [!NOTE]
+{: .note}
 > Changing a project's license does not apply retroactively. Choose an appropriate license at the start of your project and stick with it to avoid confusion and problems down the road
 
 ## Table of Contents

Guides/Guides.md

@@ -0,0 +1,9 @@
+---
+title: Guides
+nav_order: 2
+has_children: true
+---
+
+# Guides
+
+This is the landing page for all Guides. Please use the sidebar to navigate

docs/Thunderstore-Upload-Howto.md → Guides/Thunderstore-Upload-Howto.md

@@ -1,3 +1,8 @@
+---
+title: Your First Package
+parent: Guides
+---
+
 # Uploading Your First Package
 
 Hey, you made a mod, great work! But uploading to the Thunderstore can be a bit daunting and there are a few _gotchas_ that aren't really well documented. In this brief tutorial I will help you avoid common pitfalls and successfully upload your first (or perhaps beyond) package to our community.
@@ -29,7 +34,7 @@ Hey, you made a mod, great work! But uploading to the Thunderstore can be a bit
 
 There are a few basic files every package should have, lets go over them one at a time. You can follow along in this section, or use the [site documentation](https://thunderstore.io/package/create/docs/) instead if you think you can manage on your own.
 
-> [!IMPORTANT]
+{: .important}
 > All file names should match the ones I've provided exactly, this includes capitalization.
 
 If you'd like to you may follow along with a pre-made zip file: [Download](https://github.com/LethalCompanyModding/thunderstore/raw/main/attachments/howto/example-mod.zip)
@@ -40,7 +45,7 @@ If you'd like to you may follow along with a pre-made zip file: [Download](https
 
 This should be a unique icon of dimensions 256x256 for your mod. Seriously, use _exactly_ 256x256 or it will not work. It will show up in the Thunderstore and mod managers so make it interesting, descriptive and appropriate to a PG-13/PEGI-12 audience. 
 
-> [!WARNING]
+{: .warning}
 > It is Thunderstore policy that even mods marked as NSFW may not have NSFW material in the icon.
 
 ### README.MD
@@ -49,7 +54,7 @@ This file is a standard markdown file that describes your mod. Please be descrip
 
 You may use [the markdown preview tool](https://thunderstore.io/tools/markdown-preview/) to make sure your readme looks good
 
-> [!WARNING]
+{: .warning}
 > It is Thunderstore policy that even mods marked as NSFW may not have links to NSFW sites in their README file
 
 ### manifest.json
@@ -111,7 +116,7 @@ If we wanted to include multiple dependencies we should add commas to the end of
 
 ## Optional Files
 
-> [!NOTE]
+{: .note}
 > Not every file needs to be included to make your package work, but having these will make your mod stand out just a bit more and look more professional.
 
 ### CHANGELOG.MD
@@ -125,9 +130,9 @@ This is simply another markdown file, just like the README. The difference is th
 
 You may be asking "Why do I need a license?" well, a license tells users, other modders and Thunderstore staff what other people are allowed to do with your mod. A license may include provisions or prohibitions for nearly anything including selling your mod as part of a compilation, copying and redistributing your mod or forking / creating derived works.
 
-For help choosing an appropriate license for your work see [Choosing a License](Choosing-A-License.md)
+For help choosing an appropriate license for your work see [Choosing a License](Choosing-A-License.html)
 
-> [!IMPORTANT]
+{: .important}
 >  In the future, mods that plan to be used by others as a library will be required to maintain permissive licensing to remain on the Lethal Company section of the Thunderstore. Please be familiar with licenses and get ahead of the game now by choosing the correct one for your needs sooner rather than later
 
 # Package Structure
@@ -154,7 +159,7 @@ First, you should consider if you _need_ to upload a modpack. R2ModMan can expor
 
 2. If you have modified the configuration settings for any of the mods your modpack will include, copy their configuration file from your profiles BepInEx/config/ folder into a folder called `config`
 
-> [!IMPORTANT]
+{: .important}
 > Do not include any actual DLLs in your modpack. All mods your pack requires should be listed as dependencies. Do not include the contents of your BepInEx/core folder, these are system files that are already installed for every user. Do not include copyrighted content or content you do not have the full legal rights to distribute.
 
 Your final folder structure should look like this:

docs/Thunderstore-Guidelines.md → Thunderstore-Guidelines.md

@@ -1,3 +1,8 @@
+---
+title: Community Guidelines
+nav_order: 4
+---
+
 # Lethal Company Modding Community Guidelines
 
 These guidelines were last updated on the 29th of June, 2024 by public committee and have been made available publicly for those that cannot view them on the community Discord or otherwise require a reference.
@@ -56,7 +61,7 @@ When uploading a package to the community we ask that community members follow t
 
 ## Forking an Existing Mod
 
-> [!IMPORTANT] 
+{: .important}
 > Even if you have the legal right to redistribute another author's work, we ask that you follow these guidelines first before uploading a fork to our community:
 
 If the mod already exists within the Lethal Company Modding public organization, simply ask to be granted maintainer rights and get to work, great! No fork is required.

_config.yml

@@ -0,0 +1,55 @@
+title: Lethal Company Modding
+description: Thunderstore Community
+theme: just-the-docs
+color_scheme: dark
+url: https://lethalcompanymodding.github.io/Thunderstore/
+
+aux_links:
+Discord: discord.gg/lcmod
+
+defaults:
+  - scope:
+      path: "" # an empty string here means all files in the project
+    values:
+      layout: "default"
+
+callouts_level: quiet # or loud
+callouts:
+  important:
+    title: Important!
+    color: orange
+  new:
+    title: New!
+    color: green
+  note:
+    title: Notice!
+    color: yellow
+  warning:
+    title: Warning!
+    color: red
+
+search_enabled: true
+
+search:
+  # Split pages into sections that can be searched individually
+  # Supports 1 - 6, default: 2
+  heading_level: 2
+  # Maximum amount of previews per search result
+  # Default: 3
+  previews: 3
+  # Maximum amount of words to display before a matched word in the preview
+  # Default: 5
+  preview_words_before: 5
+  # Maximum amount of words to display after a matched word in the preview
+  # Default: 10
+  preview_words_after: 10
+  # Set the search token separator
+  # Default: /[\s\-/]+/
+  # Example: enable support for hyphenated search words
+  tokenizer_separator: /[\s/]+/
+  # Display the relative url in search results
+  # Supports true (default) or false
+  rel_url: true
+  # Enable or disable the search button that appears in the bottom right corner of every page
+  # Supports true or false (default)
+  button: false

_sass/custom/setup.scss

@@ -0,0 +1,4 @@
+$orange-000: #f99f7e;
+$orange-100: #f99f67;
+$orange-200: #e9c69f;
+$orange-300: #ddb12c;

assets/js/zzzz-search-data.json

@@ -0,0 +1,75 @@
+---
+layout: null
+permalink: /assets/js/search-data.json
+---
+{
+{%- assign i = 0 -%}
+{%- assign pages_array = "" | split: "" -%}
+{%- assign pages_array = pages_array | push: site.html_pages -%}
+{%- if site.just_the_docs.collections -%}
+  {%- for collection_entry in site.just_the_docs.collections -%}
+    {%- assign collection_key = collection_entry[0] -%}
+    {%- assign collection_value = collection_entry[1] -%}
+    {%- assign collection = site[collection_key] -%}
+    {%- if collection_value.search_exclude != true -%}
+      {%- assign pages_array = pages_array | push: collection -%}
+    {%- endif -%}
+  {%- endfor -%}
+{%- endif -%}
+{%- for pages in pages_array -%}
+  {%- for page in pages -%}
+    {%- if page.title and page.search_exclude != true -%}
+      {%- assign page_content = page.content -%}
+      {%- assign heading_level = site.search.heading_level | default: 2 -%}
+      {%- for j in (2..heading_level) -%}
+        {%- assign tag = '<h' | append: j -%}
+        {%- assign closing_tag = '</h' | append: j -%}
+        {%- assign page_content = page_content | replace: tag, '<h1' | replace: closing_tag, '</h1' -%}
+      {%- endfor -%}
+      {%- assign parts = page_content | split: '<h1' -%}
+      {%- assign title_found = false -%}
+      {%- for part in parts offset: 1 -%}
+        {%- assign titleAndContent = part | split: '</h1>' -%}
+        {%- assign title = titleAndContent[0] | replace_first: '>', '<h1>' | split: '<h1>' -%}
+        {%- assign title = title[1] | strip_html -%}
+        {%- assign content = titleAndContent[1] -%}
+        {%- assign url = page.url -%}
+        {%- if title == page.title and parts[0] == '' -%}
+          {%- assign title_found = true -%}
+        {%- else -%}
+          {%- assign id = titleAndContent[0] -%}
+          {%- assign id = id | split: 'id="' -%}
+          {%- if id.size == 2 -%}
+            {%- assign id = id[1] -%}
+            {%- assign id = id | split: '"' -%}
+            {%- assign id = id[0] -%}
+            {%- capture url -%}{{ url | append: '#' | append: id }}{%- endcapture -%}
+          {%- endif -%}
+        {%- endif -%}
+  {%- unless i == 0 -%},{%- endunless -%}
+  "{{ i }}": {
+    "doc": {{ page.title | jsonify }},
+    "title": {{ title | jsonify }},
+    "content": {{ content | replace: '</h', ' . </h' | replace: '<hr', ' . <hr' | replace: '</p', ' . </p' | replace: '<ul', ' . <ul' | replace: '</ul', ' . </ul' | replace: '<ol', ' . <ol' | replace: '</ol', ' . </ol' | replace: '</tr', ' . </tr' | replace: '<li', ' | <li' | replace: '</li', ' | </li' | replace: '</td', ' | </td' | replace: '<td', ' | <td' | replace: '</th', ' | </th' | replace: '<th', ' | <th' | strip_html | remove: 'Table of contents' | normalize_whitespace | replace: '. . .', '.' | replace: '. .', '.' | replace: '| |', '|' | append: ' ' | jsonify }},
+    "url": "{{ url | relative_url }}",
+    {% include lunr/custom-data.json page=page %}
+    "relUrl": "{{ url }}"
+  }
+        {%- assign i = i | plus: 1 -%}
+      {%- endfor -%}
+      {%- unless title_found -%}
+  {%- unless i == 0 -%},{%- endunless -%}
+  "{{ i }}": {
+    "doc": {{ page.title | jsonify }},
+    "title": {{ page.title | jsonify }},
+    "content": {{ parts[0] | replace: '</h', ' . </h' | replace: '<hr', ' . <hr' | replace: '</p', ' . </p' | replace: '<ul', ' . <ul' | replace: '</ul', ' . </ul' | replace: '<ol', ' . <ol' | replace: '</ol', ' . </ol' | replace: '</tr', ' . </tr' | replace: '<li', ' | <li' | replace: '</li', ' | </li' | replace: '</td', ' | </td' | replace: '<td', ' | <td' | replace: '</th', ' | </th' | replace: '<th', ' | <th' | strip_html | remove: 'Table of contents' | normalize_whitespace | replace: '. . .', '.' | replace: '. .', '.' | replace: '| |', '|' | append: ' ' | jsonify }},
+    "url": "{{ page.url | relative_url }}",
+    {% include lunr/custom-data.json page=page %}
+    "relUrl": "{{ page.url }}"
+  }
+        {%- assign i = i | plus: 1 -%}
+      {%- endunless -%}
+    {%- endif -%}
+  {%- endfor -%}
+{%- endfor %}
+}

docs/community-decisions/Referendum-2.md → community-decisions/Referendum-2.md

@@ -1,3 +1,8 @@
+---
+title: Referendum 2
+parent: Referendums
+---
+
 <h1> Lethal Company Community - Thunderstore Referendum on Rules and Policy no. 2 </h1>
 
 - [Points of Order](#points-of-order)
@@ -29,8 +34,6 @@ Traditionally, the Thunderstore asks communities to judge the suitability of a m
 
 `Axiom 4`: An author that has used our community, against our wishes, to do the above has, by their own actions, become labelled _Persona Non Grata_ and, depending on severity of the infraction, acceptable solutions range from permanent expulsion to forced reclassification as a "NSFW" mod.
 
-> Axiom 4 is currently under debate. The currently proposed change has received enough support to be considered for implementation. Please see the thread titled "Proposed change to Axiom 4" for Bunya's suggestion and voice your opinion in the poll.
-
 In order to satisfy the above Axioms and keep the community safe for all users regardless of gender identity, orientation, race, nationality, gender, ethnicity, etc, our community proposes the following policy:
 
 The Lethal Company Modding Community of the Thunderstore site defines as harmful content and prohibits the following, non-exhaustive, list of topics from appearing in the text fields of uploaded packages or links in packages:

community-decisions/Referendums.md

@@ -0,0 +1,9 @@
+---
+title: Referendums
+nav_order: 3
+has_children: true
+---
+
+# Referendums
+
+This is the landing page for all Referendums. Please use the sidebar to navigate

docs/index.md → index.md

@@ -1,12 +1,12 @@
+---
+title: Home
+layout: home
+nav_order: 1
+---
+
 # Lethal Company Modding Thunderstore Repo
 
 This repo contains notes, guidelines and other information that may be useful to members of our community. Anyone who uploads to our section is expected to be familiar with and follow our guidelines.
 
-## Community Thunderstore Policy
-
-- [Uploading Guidelines](Thunderstore-Guidelines.md)
-
-## How to Successfully Upload a Mod
-
-- [Uploading Guide](Thunderstore-Upload-Howto.md)
-- [Choosing a License](Choosing-A-License.md)
+{: .new}
+> Please use the sidebar to navigate between pages