Docs addons (#112)

* Fix indentations * Add addons page * Fix indent
Ukendio · Aug 31, 2024 · f91ab40 · f91ab40
1 parent 4f65be2
commit f91ab40
Show file tree

Hide file tree

Showing 4 changed files with 1,091 additions and 1,046 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -1,68 +1,69 @@
-import { defineConfig } from 'vitepress'
-
-// https://vitepress.dev/reference/site-config
-export default defineConfig({
-    title: "Jecs",
-    base: "/jecs/",
-    description: "A VitePress Site",
-    themeConfig: {
-        // https://vitepress.dev/reference/default-theme-config
-        nav: [
-            { text: 'Learn', link: '/' },
-            { text: 'API', link: '/api/jecs.md' },
-            { text: 'Examples', link: 'https://github.com/Ukendio/jecs/tree/main/examples' },
-        ],
-
-        sidebar: {
-            "/api/": [
-                {
-                    text: "API reference",
-                    items: [
-                        { text: "jecs", link: "/api/jecs" },
-                        { text: "World", link: "/api/world" },
-                        { text: "Query", link: "/api/query" }
-                    ]
-                }
-            ],
-            "/learn/": [
-                {
-                    text: "Introduction",
-                    items: [
-                        { text: 'Getting Started', link: '/learn/overview/get-started' },
-                        { text: 'First Jecs Project', link: '/learn/overview/first-jecs-project' }
-                    ]
-                },
-                {
-                    text: 'Concepts',
-                    items: [
-                        { text: 'Entities and Components', link: '/learn/concepts/entities-and-components' },
-                        { text: 'Queries', link: '/learn/concepts/queries' },
-                        { text: 'Relationships', link: '/learn/concepts/relationships' },
-                        { text: 'Builtin Component Traits', link: 'learn/concepts/builtin-component-traits' }
-                    ]
-                },
-                {
-                    text: "FAQ",
-                    items: [
-                        { text: 'How can I contribute?', link: '/learn/faq/contributing' }
-                    ]
-                },
-
-            ],
-            "/contributing/": [
-                {
-                    text: 'Contributing',
-                    items: [
-                        { text: 'Contribution Guidelines', link: '/learn/contributing/guidelines' },
-                        { text: 'Submitting Issues', link: '/learn/contributing/issues' },
-                        { text: 'Submitting Pull Requests', link: '/learn/contributing/pull-requests' },
-                    ]
-                }
-            ]
-        },
-
-        socialLinks: [
-            { icon: 'github', link: 'https://github.com/ukendio/jecs' }
-        ]
-    }
-})
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+    title: "Jecs",
+    base: "/jecs/",
+    description: "A VitePress Site",
+    themeConfig: {
+        // https://vitepress.dev/reference/default-theme-config
+        nav: [
+            { text: 'Learn', link: '/' },
+            { text: 'API', link: '/api/jecs.md' },
+            { text: 'Examples', link: 'https://github.com/Ukendio/jecs/tree/main/examples' },
+        ],
+
+        sidebar: {
+            "/api/": [
+                {
+                    text: "API reference",
+                    items: [
+                        { text: "jecs", link: "/api/jecs" },
+                        { text: "World", link: "/api/world" },
+                        { text: "Query", link: "/api/query" }
+                    ]
+                }
+            ],
+            "/learn/": [
+                {
+                    text: "Introduction",
+                    items: [
+                        { text: 'Getting Started', link: '/learn/overview/get-started' },
+                        { text: 'First Jecs Project', link: '/learn/overview/first-jecs-project' }
+                    ]
+                },
+                {
+                    text: 'Concepts',
+                    items: [
+                        { text: 'Entities and Components', link: '/learn/concepts/entities-and-components' },
+                        { text: 'Queries', link: '/learn/concepts/queries' },
+                        { text: 'Relationships', link: '/learn/concepts/relationships' },
+                        { text: 'Component Traits', link: 'learn/concepts/component-traits' },
+                        { text: 'Addons', link: '/learn/addons' }
+                    ]
+                },
+                {
+                    text: "FAQ",
+                    items: [
+                        { text: 'How can I contribute?', link: '/learn/faq/contributing' }
+                    ]
+                },
+
+            ],
+            "/contributing/": [
+                {
+                    text: 'Contributing',
+                    items: [
+                        { text: 'Contribution Guidelines', link: '/learn/contributing/guidelines' },
+                        { text: 'Submitting Issues', link: '/learn/contributing/issues' },
+                        { text: 'Submitting Pull Requests', link: '/learn/contributing/pull-requests' },
+                    ]
+                }
+            ]
+        },
+
+        socialLinks: [
+            { icon: 'github', link: 'https://github.com/ukendio/jecs' }
+        ]
+    }
+})
diff --git a/docs/learn/concepts/addons.md b/docs/learn/concepts/addons.md
@@ -0,0 +1,16 @@
+# Addons
+A collection of third-party jecs addons made by the community. If you would like to share what you're working on, [submit a pull request]()!
+
+# Debuggers
+
+## [jabby](https://github.com/alicesaidhi/jabby)
+
+A jecs debugger with a string-based query language and entity editing capabilities.
+
+# Schedulers
+
+## [sapphire-jecs](https://github.com/Mark-Marks/sapphire/tree/main/crates/sapphire-jecs)
+
+A batteries-included [sapphire](https://github.com/mark-marks/sapphire) scheduler for jecs
+
+This page takes wording and terminology directly from Bevy's [assets page](https://bevyengine.org/assets/)