Skip to content

TerraFirmaGreg-Team/Wiki

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

115 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TerraFirmaGreg Wiki

Source for the TerraFirmaGreg team wiki. Built with VitePress.

Source of truth. Edit pages here — the old Modpack-Modern wiki is no longer maintained.

Layout

/
├── .vitepress/
│   ├── config.mts          # Site config (locales, sidebar plugin, search)
│   ├── i18n/               # UI strings per locale (nav, footer, search, …)
│   │   ├── en_us.json      # Required template; other locales fall back to this
│   │   └── zh_cn.json      # Optional; create manually when translating UI
│   └── theme/
│       ├── i18n.ts         # Loads JSON, merges en_us fallback, builds themeConfig
│       └── ...
├── public/                 # CNAME, favicon, logo
├── docs/
│   ├── index.md            # Root; auto-redirects to visitor's locale
│   └── modern/             # Modpack-Modern namespace
│       ├── en_us/
│       ├── zh_cn/
│       └── pt_br/
├── dev.sh / dev.bat
└── package.json

Content paths: docs/modern/<locale>/<section>/<slug>.md
Public URLs: /modern/<locale>/<section>/<slug> (e.g. /modern/en_us/upgrade-guides/from-0.11-to-0.12).

Local Development

Needs Node.js >= 20. pnpm is the package manager; the launcher scripts fall back to npm.

# macOS / Linux
./dev.sh           # dev server at http://localhost:5173/
./dev.sh build     # production build
./dev.sh preview   # serve the build locally
:: Windows
dev.bat
dev.bat build
dev.bat preview

Adding a Page

Create the .md file at the same relative path in every locale (e.g. docs/modern/en_us/<section>/<slug>.md). Add frontmatter:

---
title: Page title in sidebar
order: 1
---

The sidebar is generated automatically from the folder structure. Use order to control sort position within a section. For a new section, add an index.md in that folder with title and order for the group heading.

Adding a Language

  1. Add the locale to language.json (enabledLocales and localeNames).
  2. Copy docs/modern/en_us/ to docs/modern/<new-locale>/ and translate the content.
  3. Optionally add .vitepress/i18n/<new-locale>.json with translated UI strings (omit keys that should fall back to English).

Missing UI JSON falls back to en_us.json.

Missing pages under a locale return 404. A placeholder index.md alone is enough to expose the locale home URL.

Contributing

Open a PR for fixes or new pages. Not comfortable with git? Ping us on Discord.

About

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors