This is the documentation repository of LibreTranslate, a free and open source translation API.
src/docs: directory with documentation pages in mdx and markdown format
- The tone of translation should be technical. The context of translation is that of software API.
- When updating translations, always look at the current git diff to see which sections were changed. If there are no active changes in the current branch, compare against the latest commit (git diff HEAD~1 HEAD)
- Never edit or commit any file in
src/content/docs/communityorsrc/content/docs/guidesorsrc/content/index.mdx. These are the original English pages - Always preserve images in the proper places.
- Each translation for other languages, like Italian or Spanish, needs to be added as subfolder in
src/content/docs/[langcode], wherelangcodeis the 2 letter ISO 639 language code. For example, Italian docs go insrc/content/docs/it/. - Each translation must have an
index.mdxand copies of each subfolder (community,guides) and a copy of each markdown file in each subfolder. Always verify that the number of pages match. - Always create/update ALL the markdown files when asked to add or update a translation.
- Always translate from English, never from another language.
- Always verify all translations for accuracy and completeness in all markdown files, then fix all inaccuracies and fill any missing section, if any.
- When translating internal links, we always reference them with the appropriate URL that maps to a markdown file of the translation.
- Never modify any other file other than those in
src/contentorastro.config.mjswithout explicit permission. - When translating, always check that all the sidebar items in
astro.config.mjshave a proper translation item in thetranslationskey.
nvm use 22
npm run buildThe outputs will be in dist/.
These words / sentences should be treated carefully:
Should be interpreted as "computer" or "system" (not a literal machine).
E.g. in Spanish use "equipo" or "computadora", not "máquina".