Skip to content

Latest commit

 

History

History
81 lines (57 loc) · 2.82 KB

README.md

File metadata and controls

81 lines (57 loc) · 2.82 KB
Raw

Website

This website is built using Docusaurus 2, a modern static website generator.

Most of the content sits inside the docs folder and the versioned_docs folder in the form of markdown.

Installation

npm install

Local Development

npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. Note this only builds for English locale unlike a production build.

Documentation is written in mdx, a superset of markdown empowered with jsx. JetBrains and VSCode both provide MDX plugins.

Production Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Localization

Localization is done on GitLocalize. You can sign in with your GitHub account to start translating.

When you add to the docs in the mdx files,
Contributors on GitLocalize will translate the added content and the translation will get dumped under the i18n folder in a later time.

If you are a native speaker of one of the translated languages, and you are interested in translating your edits yourself, you are welcome to navigate to the folder and do it yourself!

Localizing headings

If you want to write displayed content in html/jsx instead of vanilla markdown, You should wrap your text in <Translate/> tags. It helps docusaurus to extract those texts and compile them to .json files to get further translated in GitLocalize.

import Translate from '@docusaurus/Translate'

<h2>
    <Translate id="header.translation.id" description="the heading description">
        This heading will be translated
    </Translate>
</h2>

If your pull request adds new <Translation> tags, make sure you do npm run write-translations to generate the new stubs for later localization. And you are always welcome to add localization yourself in your native languages!

Common issues in localization

Pages (.mdx) are translated one-to-one and the english text is used as fallback if no translation exists. Sometimes, when building you might see a warning, and subsequent error, like this

[WARNING] Docs markdown link couldn't be resolved: (../components/refs.mdx) in /yew/website/versioned_docs/version-0.18.0/concepts/html/events.mdx for version 0.18.0

This means that the non-translated page at versioned_docs/version-0.18.0/concepts/html/events.mdx contains a relative link - ../components/refs.mdx - to a page that has been translated. Change the link to be relative to the doc root folder, in this case concepts/components/res.mdx, or, if you find the time, also translate the offending page.