docs: seo basics

meza · Jan 11, 2025 · bae2b00 · bae2b00
1 parent 86bc34f
commit bae2b00
Show file tree

Hide file tree

Showing 7 changed files with 275 additions and 30 deletions.
diff --git a/docs/.docusaurus/docusaurus.config.mjs b/docs/.docusaurus/docusaurus.config.mjs
@@ -4,8 +4,9 @@
  * Modify the docusaurus.config.js file at your site's root instead.
  */
 export default {
-  "title": "My Site",
-  "favicon": "img/favicon.ico",
+  "title": "Stonecraft – Simplify Multi-Loader, Multi-Version Minecraft Mod Development",
+  "titleDelimiter": "–",
+  "favicon": "img/[email protected]",
   "url": "https://stonecraft.meza.gg",
   "baseUrl": "/",
   "trailingSlash": false,
@@ -34,7 +35,77 @@ export default {
       }
     ]
   ],
+  "headTags": [
+    {
+      "tagName": "link",
+      "attributes": {
+        "rel": "canonical",
+        "href": "https://stonecraft.meza.gg"
+      }
+    },
+    {
+      "tagName": "script",
+      "attributes": {
+        "type": "application/ld+json"
+      },
+      "innerHTML": "{\"@context\":\"https://schema.org\",\"@type\":\"SoftwareApplication\",\"name\":\"Stonecraft\",\"description\":\"Stonecraft is a Gradle plugin that simplifies multi-loader, multi-version Minecraft mod development with Fabric, Forge, and NeoForge support.\",\"applicationCategory\":\"DeveloperTool\",\"operatingSystem\":\"Cross-platform\",\"url\":\"https://stonecraft.meza.gg/\",\"author\":{\"@type\":\"Person\",\"name\":\"Meza\"}}"
+    }
+  ],
   "themeConfig": {
+    "metadata": [
+      {
+        "name": "description",
+        "content": "Stonecraft is a Gradle plugin that streamlines multi-loader, multi-version Minecraft mod development. Build Fabric, Forge, and NeoForge mods in a single codebase and simplify releases to Modrinth and CurseForge."
+      },
+      {
+        "name": "keywords",
+        "content": "Minecraft modding, Gradle plugin, Fabric mod, Forge mod, NeoForge, multi-loader modding, Stonecutter, Architectury, Modrinth, CurseForge"
+      },
+      {
+        "name": "og:title",
+        "content": "Stonecraft – Simplify Multi-Loader, Multi-Version Minecraft Mod Development"
+      },
+      {
+        "name": "og:description",
+        "content": "Stonecraft is a Gradle plugin that streamlines multi-loader, multi-version Minecraft mod development. Build Fabric, Forge, and NeoForge mods in a single codebase and simplify releases to Modrinth and CurseForge."
+      },
+      {
+        "name": "og:type",
+        "content": "website"
+      },
+      {
+        "name": "og:url",
+        "content": "https://stonecraft.meza.gg"
+      },
+      {
+        "name": "og:image",
+        "content": "https://stonecraft.meza.gg/img/[email protected]"
+      },
+      {
+        "name": "twitter:card",
+        "content": "summary_large_image"
+      },
+      {
+        "name": "twitter:site",
+        "content": "@houseofmeza"
+      },
+      {
+        "name": "twitter:creator",
+        "content": "@houseofmeza"
+      },
+      {
+        "name": "twitter:image",
+        "content": "https://stonecraft.meza.gg/img/[email protected]"
+      },
+      {
+        "name": "twitter:title",
+        "content": "Stonecraft – Simplify Multi-Loader, Multi-Version Minecraft Mod Development"
+      },
+      {
+        "name": "twitter:description",
+        "content": "Stonecraft is a Gradle plugin that streamlines multi-loader, multi-version Minecraft mod development. Build Fabric, Forge, and NeoForge mods in a single codebase and simplify releases to Modrinth and CurseForge."
+      }
+    ],
     "announcementBar": {
       "isCloseable": true,
       "id": "star",
@@ -367,7 +438,6 @@ export default {
         "groupByYear": true
       }
     },
-    "metadata": [],
     "tableOfContents": {
       "minHeadingLevel": 2,
       "maxHeadingLevel": 3
@@ -400,11 +470,9 @@ export default {
   "plugins": [],
   "themes": [],
   "scripts": [],
-  "headTags": [],
   "stylesheets": [],
   "clientModules": [],
   "tagline": "",
-  "titleDelimiter": "|",
   "noIndex": false,
   "markdown": {
     "format": "mdx",

diff --git a/docs/.docusaurus/registry.js b/docs/.docusaurus/registry.js
diff --git a/docs/.docusaurus/routes.js b/docs/.docusaurus/routes.js
@@ -2,6 +2,41 @@ import React from 'react';
 import ComponentCreator from '@docusaurus/ComponentCreator';
 
 export default [
+  {
+    path: '/__docusaurus/debug',
+    component: ComponentCreator('/__docusaurus/debug', '5ff'),
+    exact: true
+  },
+  {
+    path: '/__docusaurus/debug/config',
+    component: ComponentCreator('/__docusaurus/debug/config', '5ba'),
+    exact: true
+  },
+  {
+    path: '/__docusaurus/debug/content',
+    component: ComponentCreator('/__docusaurus/debug/content', 'a2b'),
+    exact: true
+  },
+  {
+    path: '/__docusaurus/debug/globalData',
+    component: ComponentCreator('/__docusaurus/debug/globalData', 'c3c'),
+    exact: true
+  },
+  {
+    path: '/__docusaurus/debug/metadata',
+    component: ComponentCreator('/__docusaurus/debug/metadata', '156'),
+    exact: true
+  },
+  {
+    path: '/__docusaurus/debug/registry',
+    component: ComponentCreator('/__docusaurus/debug/registry', '88c'),
+    exact: true
+  },
+  {
+    path: '/__docusaurus/debug/routes',
+    component: ComponentCreator('/__docusaurus/debug/routes', '000'),
+    exact: true
+  },
   {
     path: '/',
     component: ComponentCreator('/', '2e7'),

diff --git a/docs/.docusaurus/routesChunkNames.json b/docs/.docusaurus/routesChunkNames.json
@@ -1,23 +1,66 @@
 {
+  "/__docusaurus/debug-5ff": {
+    "__comp": "__comp---theme-debug-config-23-a-2ff",
+    "__context": {
+      "plugin": "plugin---docusaurus-debugb-38-ad3"
+    }
+  },
+  "/__docusaurus/debug/config-5ba": {
+    "__comp": "__comp---theme-debug-config-23-a-2ff",
+    "__context": {
+      "plugin": "plugin---docusaurus-debugb-38-ad3"
+    }
+  },
+  "/__docusaurus/debug/content-a2b": {
+    "__comp": "__comp---theme-debug-contentba-8-ce7",
+    "__context": {
+      "plugin": "plugin---docusaurus-debugb-38-ad3"
+    },
+    "__props": "__props---docusaurus-debug-content-3-c-0-be2"
+  },
+  "/__docusaurus/debug/globalData-c3c": {
+    "__comp": "__comp---theme-debug-global-dataede-0fa",
+    "__context": {
+      "plugin": "plugin---docusaurus-debugb-38-ad3"
+    }
+  },
+  "/__docusaurus/debug/metadata-156": {
+    "__comp": "__comp---theme-debug-site-metadata-68-e-3d4",
+    "__context": {
+      "plugin": "plugin---docusaurus-debugb-38-ad3"
+    }
+  },
+  "/__docusaurus/debug/registry-88c": {
+    "__comp": "__comp---theme-debug-registry-679-501",
+    "__context": {
+      "plugin": "plugin---docusaurus-debugb-38-ad3"
+    }
+  },
+  "/__docusaurus/debug/routes-000": {
+    "__comp": "__comp---theme-debug-routes-946-699",
+    "__context": {
+      "plugin": "plugin---docusaurus-debugb-38-ad3"
+    }
+  },
   "/-2e7": {
-    "__comp": "5e95c892",
+    "__comp": "__comp---theme-docs-root-5-e-9-0b6",
     "__context": {
-      "plugin": "aba21aa0"
+      "plugin": "plugin---aba-d70"
     }
   },
   "/-20b": {
-    "__comp": "a7bd4aaa",
-    "__props": "22dd74f7"
+    "__comp": "__comp---theme-doc-version-roota-7-b-5de",
+    "__props": "__props---22-d-307"
   },
   "/-314": {
-    "__comp": "a94703ab"
+    "__comp": "__comp---theme-doc-roota-94-67a"
   },
   "/Quickstart-ece": {
-    "__comp": "17896441",
-    "content": "351e6096"
+    "__comp": "__comp---theme-doc-item-178-a40",
+    "content": "content---quickstart-351-aec"
   },
   "/-1e5": {
-    "__comp": "17896441",
-    "content": "09c03e3c"
+    "__comp": "__comp---theme-doc-item-178-a40",
+    "content": "content---09-c-d3e"
   }
 }
diff --git a/docs/.docusaurus/site-metadata.json b/docs/.docusaurus/site-metadata.json
@@ -11,9 +11,9 @@
       "name": "@docusaurus/plugin-content-pages",
       "version": "3.7.0"
     },
-    "docusaurus-plugin-sitemap": {
+    "docusaurus-plugin-debug": {
       "type": "package",
-      "name": "@docusaurus/plugin-sitemap",
+      "name": "@docusaurus/plugin-debug",
       "version": "3.7.0"
     },
     "docusaurus-plugin-svgr": {

diff --git a/docs/docs/Quickstart.md b/docs/docs/Quickstart.md
@@ -1,18 +1,66 @@
 
 ## Quickstart
 
+### Add the plugin to build.gradle[.kts]
+
+If you already use Architectury, make sure to add Stonecraft BEFORE the Architectury plugin.
+
+```kotlin
+// build.gradle.kts
+plugins {
+   id("gg.meza.stonecraft") version "1.0.0"   
+}
+```
+
+### Set up Stonecutter
+
+#### Setting up supported version
+
+Create a `settings.gradle[.kts]` file in your project root with the following content:
+
 ```kotlin
 // settings.gradle.kts
 pluginManagement {
     repositories {
-        maven("https://maven.meza.gg/")
+        mavenCentral()
+        gradlePluginPortal()
+        maven("https://maven.kikugie.dev/releases")
+    }
+}
+plugins {
+    id("dev.kikugie.stonecutter") version "0.5"
+}
+
+stonecutter {
+    centralScript = "build.gradle.kts"
+    kotlinController = true
+    shared {
+        fun mc(version: String, vararg loaders: String) {
+            // Make the relevant version directories named "1.20.2-fabric", "1.20.2-forge", etc.
+            for (it in loaders) vers("$version-$it", version)
+        }
+
+        mc("1.21.3", "fabric", "forge", "neoforge")
+        mc("1.21.4", "fabric", "forge", "neoforge")
+
     }
+    create(rootProject)
 }
+
+rootProject.name = "YourModName"
+
 ```
 
+#### Setting up the stonecutter
+
+Create a `stonecutter.gradle[.kts]` file in your project root with the following content:
+
 ```kotlin
-// build.gradle.kts
+// stonecutter.gradle.kts
 plugins {
-   id("gg.meza.stonecraft") version "1.0.0"   
+    id("dev.kikugie.stonecutter")
+    id("gg.meza.stonecraft")
 }
+
+stonecutter active "1.21.4-fabric" /* [SC] DO NOT EDIT */
 ```