From 7ac5129cee77d71bdc7d5d07b92310ec03dd5398 Mon Sep 17 00:00:00 2001 From: luxferre Date: Fri, 1 May 2026 13:04:01 +0100 Subject: [PATCH] feat: readme update Added additional Docusaurus i18n command. Put all localization commands within code blocks. Removed autogen Docusaurus readme. --- README.md | 20 +++++++++++++++----- README2.md | 41 ----------------------------------------- 2 files changed, 15 insertions(+), 46 deletions(-) delete mode 100644 README2.md diff --git a/README.md b/README.md index 8cd668c..c4d5727 100644 --- a/README.md +++ b/README.md @@ -18,19 +18,29 @@ Key files for localization are: ### Locale commands To update translation key values: -npm run write-translations -- --locale + +`npm run write-translations -- --locale ` + +By default, write-translate only appends new values. To also update existing values: +- Note this will overwrite **all** JSON stored translations to English. + +`docusaurus write-translations --locale --overrride` To updated po4a consolidated .pot and .po files from English markdown files (with po4a tool installed): -po4a po4a.conf --no-translations + +`po4a po4a.conf --no-translations` To update localization markdown files from po4a consolidated .po files (with po4a tool installed): -po4a po4a.conf --no-update + +`po4a po4a.conf --no-update` To run the site in a specific locale: -npm run start -- --locale + +`npm run start -- --locale ` To build the static site for all locales: -npm run build + +`npm run build` ### Localization mapping diff --git a/README2.md b/README2.md deleted file mode 100644 index b28211a..0000000 --- a/README2.md +++ /dev/null @@ -1,41 +0,0 @@ -# Website - -This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. - -## Installation - -```bash -yarn -``` - -## Local Development - -```bash -yarn 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. - -## Build - -```bash -yarn build -``` - -This command generates static content into the `build` directory and can be served using any static contents hosting service. - -## Deployment - -Using SSH: - -```bash -USE_SSH=true yarn deploy -``` - -Not using SSH: - -```bash -GIT_USER= yarn deploy -``` - -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.