Skip to content

Nested Lang Docs #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: vitepress
Choose a base branch
from
Open

Nested Lang Docs #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e2fa846
nested lang docs moment
chyzman Sep 16, 2025
6e622ad
nested lang docs moment
chyzman Sep 16, 2025
3495a0e
what fuck docs
chyzman Sep 16, 2025
be47c3a
docs in progress:tm:
chyzman Sep 22, 2025
b5060a0
nested lang + json5 documentation
chyzman Sep 26, 2025
0e1d862
shhhh
chyzman Sep 27, 2025
6247650
i love code input
chyzman Sep 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
166 changes: 89 additions & 77 deletions .vitepress/config.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { readFileSync } from 'fs';
import {readFileSync} from 'fs';
import kbd from 'markdown-it-kbd';
import { defineConfig, HeadConfig } from 'vitepress';
import { tabsMarkdownPlugin } from 'vitepress-plugin-tabs';
import { projectMeta } from '../components/meta.ts';
import {defineConfig, HeadConfig} from 'vitepress';
import {tabsMarkdownPlugin} from 'vitepress-plugin-tabs';
import {projectMeta} from '../components/meta.ts';

const mcfunction = JSON.parse(readFileSync('mcfunction-grammar.json', 'utf-8'));

Expand All @@ -22,7 +22,7 @@ export default defineConfig({
},
},
head: [
['link', { rel: 'icon', href: '/favicon.ico' }]
['link', {rel: 'icon', href: '/favicon.ico'}]
],
sitemap: {
hostname: 'https://docs.wispforest.io/'
Expand All @@ -34,22 +34,22 @@ export default defineConfig({
if (!(entryDir in projectMeta)) return [];

const headData: HeadConfig[] = [];
headData.push(['meta', { property: 'og:site_name', content: ctx.siteData.title }]);
headData.push(['meta', {property: 'og:site_name', content: ctx.siteData.title}]);

if (ctx.pageData.filePath != 'index.md') {
headData.push(['meta', { property: 'og:title', content: ctx.pageData.title }]);
headData.push(['meta', {property: 'og:title', content: ctx.pageData.title}]);
} else {
headData.push(['meta', { property: 'og:title', content: 'Home' }]);
headData.push(['meta', {property: 'og:title', content: 'Home'}]);
}

const { icon, description } = projectMeta[entryDir];
const {icon, description} = projectMeta[entryDir];

headData.push(['meta', { property: 'og:description', content: description }]);
headData.push(['meta', { property: 'og:image', content: `https://docs.wispforest.io${ctx.siteData.base}${icon}` }]);
headData.push(['meta', {property: 'og:description', content: description}]);
headData.push(['meta', {property: 'og:image', content: `https://docs.wispforest.io${ctx.siteData.base}${icon}`}]);

if ('color' in projectMeta[entryDir]) {
const { color } = projectMeta[entryDir];
headData.push(['meta', { property: 'theme-color', content: color }]);
const {color} = projectMeta[entryDir];
headData.push(['meta', {property: 'theme-color', content: color}]);
}

return headData;
Expand All @@ -59,7 +59,7 @@ export default defineConfig({
logo: '/icon-header.png',

nav: [
{ text: 'Wisp Forest Maven', link: 'https://maven.wispforest.io/#/' },
{text: 'Wisp Forest Maven', link: 'https://maven.wispforest.io/#/'},
],

outline: 'deep',
Expand All @@ -70,105 +70,117 @@ export default defineConfig({

sidebar: {
'/isometric-renders/': [
{ text: 'Home', link: '/isometric-renders/home' },
{ text: '/isorender', link: '/isometric-renders/slash_isorender' },
{ text: 'Options', link: '/isometric-renders/options' },
{text: 'Home', link: '/isometric-renders/home'},
{text: '/isorender', link: '/isometric-renders/slash_isorender'},
{text: 'Options', link: '/isometric-renders/options'},
],
'/owo/': [
{ text: 'Setup', link: '/owo/setup' },
{ text: 'Features', link: '/owo/features' },
{ text: 'Registration', link: '/owo/registration' },
{ text: 'Item Groups', link: '/owo/item-groups' },
{ text: 'Recipe Remainders', link: '/owo/recipe-remainders' },
{ text: 'Networking', link: '/owo/networking' },
{ text: 'Endecs', link: '/owo/endec' },
{ text: 'Rich Translations', link: '/owo/rich-translations' },
{ text: 'System Properties', link: '/owo/system-properties' },
{ text: 'RenderDoc Integration', link: '/owo/renderdoc' },
{
items: [
{text: 'Setup', link: '/owo/setup'},
{text: 'Features', link: '/owo/features'},
{text: 'Registration', link: '/owo/registration'},
{text: 'Item Groups', link: '/owo/item-groups'},
{text: 'Networking', link: '/owo/networking'},
{text: 'Endecs', link: '/owo/endec'},
{text: 'System Properties', link: '/owo/system-properties'},
{text: 'RenderDoc Integration', link: '/owo/renderdoc'},
]
},
{
text: 'Data Extensions',
link: 'owo/config/index',
items: [
{text: 'JSON5', link: '/owo/data-extensions/json5'},
{text: 'Rich Translations', link: '/owo/data-extensions/rich-translations'},
{text: 'Nested Lang', link: '/owo/data-extensions/nested-lang'},
{text: 'Recipe Remainders', link: '/owo/data-extensions/recipe-remainders'}
]
},
{
text: 'Config',
link: '/owo/config/index',
items: [
{ text: 'Getting Started', link: '/owo/config/getting-started.md' },
{ text: 'Constraints', link: '/owo/config/constraints.md' },
{ text: 'Annotations', link: '/owo/config/annotations.md' },
{ text: 'Synchronization', link: '/owo/config/synchronization.md' },
{ text: 'Options', link: '/owo/config/options.md' },
{text: 'Getting Started', link: '/owo/config/getting-started'},
{text: 'Constraints', link: '/owo/config/constraints'},
{text: 'Annotations', link: '/owo/config/annotations'},
{text: 'Synchronization', link: '/owo/config/synchronization'},
{text: 'Options', link: '/owo/config/options'},
]
},
{
text: 'UI',
link: '/owo/ui/index',
items: [
{ text: 'Getting Started', link: '/owo/ui/getting-started.md' },
{ text: 'owo-ui Academy', link: '/owo/ui/academy.md' },
{ text: 'Component Basics', link: '/owo/ui/component-basics.md' },
{ text: 'Layout Basics', link: '/owo/ui/layout-basics.md' },
{ text: 'Utility Components', link: '/owo/ui/utility-components.md' },
{text: 'Getting Started', link: '/owo/ui/getting-started'},
{text: 'owo-ui Academy', link: '/owo/ui/academy'},
{text: 'Component Basics', link: '/owo/ui/component-basics'},
{text: 'Layout Basics', link: '/owo/ui/layout-basics'},
{text: 'Utility Components', link: '/owo/ui/utility-components'},
{
text: 'owo-ui components',
link: '/owo/ui/components/index.md',
link: '/owo/ui/components/index',
collapsed: true,
items: [
{ text: 'Button', link: '/owo/ui/components/button.md', },
{ text: 'Checkbox', link: '/owo/ui/components/checkbox.md', },
{ text: 'Collapsible Container', link: '/owo/ui/components/collapsible-container.md', },
{ text: 'Dropdown', link: '/owo/ui/components/dropdown.md', },
{ text: 'Flow Layout', link: '/owo/ui/components/flow-layout.md', },
{ text: 'Grid Layout', link: '/owo/ui/components/grid-layout.md', },
{ text: 'Label', link: '/owo/ui/components/label.md', },
{ text: 'Scroll Container', link: '/owo/ui/components/scroll-container.md', },
{ text: 'Slider', link: '/owo/ui/components/slider.md', },
{ text: 'Templates', link: '/owo/ui/components/templates.md', },
{text: 'Button', link: '/owo/ui/components/button',},
{text: 'Checkbox', link: '/owo/ui/components/checkbox',},
{text: 'Collapsible Container', link: '/owo/ui/components/collapsible-container',},
{text: 'Dropdown', link: '/owo/ui/components/dropdown',},
{text: 'Flow Layout', link: '/owo/ui/components/flow-layout',},
{text: 'Grid Layout', link: '/owo/ui/components/grid-layout',},
{text: 'Label', link: '/owo/ui/components/label',},
{text: 'Scroll Container', link: '/owo/ui/components/scroll-container',},
{text: 'Slider', link: '/owo/ui/components/slider',},
{text: 'Templates', link: '/owo/ui/components/templates',},
]
},
]
},
],
'/numismatic-overhaul/': [
{ text: 'Home', link: '/numismatic-overhaul/home' },
{ text: 'Shops', link: '/numismatic-overhaul/shop' },
{ text: 'Villager Trade Data Format', link: '/numismatic-overhaul/trades' },
{text: 'Home', link: '/numismatic-overhaul/home'},
{text: 'Shops', link: '/numismatic-overhaul/shop'},
{text: 'Villager Trade Data Format', link: '/numismatic-overhaul/trades'},
],
'/lavender/': [
{ text: 'Setup', link: '/lavender/setup' },
{ text: 'Getting Started', link: '/lavender/getting-started' },
{ text: 'Metadata Format', link: '/lavender/metadata-format' },
{ text: 'Markdown Syntax', link: '/lavender/markdown-syntax' },
{ text: 'Structures', link: '/lavender/structures' },
{ text: 'Writing Extensions', link: '/lavender/writing-extensions' },
{text: 'Setup', link: '/lavender/setup'},
{text: 'Getting Started', link: '/lavender/getting-started'},
{text: 'Metadata Format', link: '/lavender/metadata-format'},
{text: 'Markdown Syntax', link: '/lavender/markdown-syntax'},
{text: 'Structures', link: '/lavender/structures'},
{text: 'Writing Extensions', link: '/lavender/writing-extensions'},
],
'/accessories/': [
{ text: 'Home', link: '/accessories/home' },
{ text: 'FAQ', link: '/accessories/faq' },
{text: 'Home', link: '/accessories/home'},
{text: 'FAQ', link: '/accessories/faq'},
{
text: 'General',
items: [
{ text: 'Creating and Modifying Slots', link: '/accessories/general/slot_types', },
{ text: 'Default Slots', link: '/accessories/general/defaulted_slots', },
{ text: 'Adjusting Accessory Equipablity', link: '/accessories/general/binding_accessories_to_slots', },
{ text: 'Binding Slots to Entities', link: '/accessories/general/binding_slots_to_entities', },
{ text: 'Creating Slot Groups', link: '/accessories/general/slot_groups', },
{ text: 'Adjusting Slot Amount', link: '/accessories/general/adjusting_slot_amount', },
{text: 'Creating and Modifying Slots', link: '/accessories/general/slot_types',},
{text: 'Default Slots', link: '/accessories/general/defaulted_slots',},
{text: 'Adjusting Accessory Equipablity', link: '/accessories/general/binding_accessories_to_slots',},
{text: 'Binding Slots to Entities', link: '/accessories/general/binding_slots_to_entities',},
{text: 'Creating Slot Groups', link: '/accessories/general/slot_groups',},
{text: 'Adjusting Slot Amount', link: '/accessories/general/adjusting_slot_amount',},
]
},
{
text: 'Developer',
items: [
{ text: 'Setup Environment', link: '/accessories/developer/dev_setup', },
{ text: 'API Fundamentals', link: '/accessories/developer/api_fundamentals', },
{ text: 'Rendering API Breakdown', link: '/accessories/developer/rendering_api', },
{ text: 'Available API Events', link: '/accessories/developer/api_events', },
{ text: 'ItemStack Data Components', link: '/accessories/developer/itemstack_components', },
{text: 'Setup Environment', link: '/accessories/developer/dev_setup',},
{text: 'API Fundamentals', link: '/accessories/developer/api_fundamentals',},
{text: 'Rendering API Breakdown', link: '/accessories/developer/rendering_api',},
{text: 'Available API Events', link: '/accessories/developer/api_events',},
{text: 'ItemStack Data Components', link: '/accessories/developer/itemstack_components',},
]
},
],
'/alloy-forgery/': [
{ text: 'Home', link: '/alloy-forgery/home' },
{ text: 'Adding Recipes and Fuels', link: '/alloy-forgery/adding-recipes-and-fuels' },
{ text: 'How to build a Forge', link: '/alloy-forgery/building-a-forge' },
{ text: 'Recipe Adaptation', link: '/alloy-forgery/recipe-adaptation' },
{ text: 'Defining new Forges though Data', link: '/alloy-forgery/defining-a-forge' },
{text: 'Home', link: '/alloy-forgery/home'},
{text: 'Adding Recipes and Fuels', link: '/alloy-forgery/adding-recipes-and-fuels'},
{text: 'How to build a Forge', link: '/alloy-forgery/building-a-forge'},
{text: 'Recipe Adaptation', link: '/alloy-forgery/recipe-adaptation'},
{text: 'Defining new Forges though Data', link: '/alloy-forgery/defining-a-forge'},
],
},

Expand All @@ -177,8 +189,8 @@ export default defineConfig({
},

socialLinks: [
{ icon: 'discord', link: 'https://discord.gg/xrwHKktV2d' },
{ icon: 'github', link: 'https://github.com/wisp-forest/docs' },
{icon: 'discord', link: 'https://discord.gg/xrwHKktV2d'},
{icon: 'github', link: 'https://github.com/wisp-forest/docs'},
]
}
})
4 changes: 2 additions & 2 deletions alloy-forgery/adding-recipes-and-fuels.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Overrides allow changing the output item depending on the tier of the Forge. Acc
## Recipe Remainders
<VersionMarker version="2.0.17+ and owo-lib 0.8.0+" />

Due to Vanilla's very generic recipe remainders, you can use owo's [Recipe Specific Remainders](../owo/recipe-remainders.md) instead, allowing for fully customizable recipe remainders, or use the built-in global remainder system loaded through the `data/<namespace>/forge_remainder` folder.
Due to Vanilla's very generic recipe remainders, you can use owo's [Recipe Specific Remainders](../owo/data-extensions/recipe-remainders.md) instead, allowing for fully customizable recipe remainders, or use the built-in global remainder system loaded through the `data/<namespace>/forge_remainder` folder.

A example for global Alloy Forgery remainders is below:
```JSON
Expand Down Expand Up @@ -168,4 +168,4 @@ Alloy Forgery loads fuel from a specific folder in data. The path is `data/<name
]
}
```
The special field `return_item` is optional, and is intended for when you want to do something similar to returning an empty bucket after using a lava bucket with the forge.
The special field `return_item` is optional, and is intended for when you want to do something similar to returning an empty bucket after using a lava bucket with the forge.
Loading