mirror of
https://github.com/daffyyyy/CS2-SimpleAdmin.git
synced 2026-02-18 18:49:23 +00:00
b0d8696756
Introduces a new documentation site for CS2-SimpleAdmin using Docusaurus, including developer API references, tutorials, user guides, and module documentation. Removes the CleanModule example and updates FunCommands and ExampleModule. Also updates main plugin and API files to support new documentation and module structure.
89 lines
1.5 KiB
Markdown
89 lines
1.5 KiB
Markdown
---
|
|
sidebar_position: 2
|
|
---
|
|
|
|
# Translate your site
|
|
|
|
Let's translate `docs/intro.md` to French.
|
|
|
|
## Configure i18n
|
|
|
|
Modify `docusaurus.config.js` to add support for the `fr` locale:
|
|
|
|
```js title="docusaurus.config.js"
|
|
export default {
|
|
i18n: {
|
|
defaultLocale: 'en',
|
|
locales: ['en', 'fr'],
|
|
},
|
|
};
|
|
```
|
|
|
|
## Translate a doc
|
|
|
|
Copy the `docs/intro.md` file to the `i18n/fr` folder:
|
|
|
|
```bash
|
|
mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/
|
|
|
|
cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md
|
|
```
|
|
|
|
Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French.
|
|
|
|
## Start your localized site
|
|
|
|
Start your site on the French locale:
|
|
|
|
```bash
|
|
npm run start -- --locale fr
|
|
```
|
|
|
|
Your localized site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/) and the `Getting Started` page is translated.
|
|
|
|
:::caution
|
|
|
|
In development, you can only use one locale at a time.
|
|
|
|
:::
|
|
|
|
## Add a Locale Dropdown
|
|
|
|
To navigate seamlessly across languages, add a locale dropdown.
|
|
|
|
Modify the `docusaurus.config.js` file:
|
|
|
|
```js title="docusaurus.config.js"
|
|
export default {
|
|
themeConfig: {
|
|
navbar: {
|
|
items: [
|
|
// highlight-start
|
|
{
|
|
type: 'localeDropdown',
|
|
},
|
|
// highlight-end
|
|
],
|
|
},
|
|
},
|
|
};
|
|
```
|
|
|
|
The locale dropdown now appears in your navbar:
|
|
|
|
|
|
|
|
## Build your localized site
|
|
|
|
Build your site for a specific locale:
|
|
|
|
```bash
|
|
npm run build -- --locale fr
|
|
```
|
|
|
|
Or build your site to include all the locales at once:
|
|
|
|
```bash
|
|
npm run build
|
|
```
|