Skip to main content

Content and i18n

Pages are Markdown files under src/jsMain/resources. The Gradle plugin copies them into the site directory; nothing is generated from Kotlin for prose.

DirectoryEnds up atPurpose
resources/docsdocs/Documentation pages
resources/blogblog/Blog posts (disabled in this site)
resources/pagessrc/pages/Standalone pages (.md, .mdx or the .jsx shim of a Kotlin component)
resources/csssrc/css/Extra stylesheets
resources/staticstatic/Files copied as-is
resources/i18ni18n/Translations

Translations​

docusaurus.config.mjs declares two locales, en and zh-Hans, and English is the source language. Every translated page mirrors its source path under the locale's own plugin directory — documentation pages under docusaurus-plugin-content-docs/current/, standalone pages under docusaurus-plugin-content-pages/:

resources/docs/intro.md
resources/i18n/zh-Hans/docusaurus-plugin-content-docs/current/intro.md

resources/pages/index.md
resources/i18n/zh-Hans/docusaurus-plugin-content-pages/index.md

Page copy therefore stays in the page: two Markdown files, one per locale, and the home page is no exception. code.json under the same i18n directory is for the strings a component owns — the navbar, the footer, and anything a Kotlin page renders with translate { id = …; message = "…" }.

Sidebar entries and the previous/next buttons take their labels from the page they point at — its heading, or a sidebar_label in its front matter — so a translated page brings its translated label along. A category has no page of its own, so its label lives in the docs plugin's own translation file, i18n/<locale>/docusaurus-plugin-content-docs/current.json.

Why not MDX for prose​

MDX is available, and a page may use it. It is just not the default: a page that is only prose is a .md file, so nothing about it depends on a React component tree. When a page does need a <Layout>-level tweak or a component, name it index.mdx and it goes through the same MDX pipeline — resources/pages is copied verbatim, so the extension is the only thing that changes.