From f764155b77e957db1b260a8e44dfc50525f47636 Mon Sep 17 00:00:00 2001 From: luxferre Date: Wed, 29 Apr 2026 14:07:08 +0100 Subject: [PATCH] feat: updated readme --- README.md | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index d5aa379..8cd668c 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,40 @@ # ButterBox Website for 2026... and beyond! -Welcome to our new site, built on Docusaurus. This integrates our previous simple jekyll site and our documentation work from Gitbook into a single site. It also provides a blog capability, and built-in capability for localization. +Welcome to our new site, built on Docusaurus. This integrates our previous simple Jekyll site and our documentation work from Gitbook into a single site. It also provides a blog capability, and built-in capability for localization. ## Localization -All localizations (currently en, es, ru and zh-Hans) are under the www/i18n/ folder structure +All localizations (currently en, es, ru and zh-Hans) are under the i18n/ folder structure Key files for localization are: -- homepage and general strings: www/i18n//code.json -- navbar: www/i18n//docusaurus-theme-classic/navbar.json -- footer: www/i18n//docusaurus-theme-classic/footer.json -- english markdown docs: www/docs/ -- localization markdown docs: www/i18n//docusaurus-plugin-content-docs/current/ +- English Markdown docs: docs/ +- homepage and general strings: i18n//code.json +- navbar: i18n//docusaurus-theme-classic/navbar.json +- footer: i18n//docusaurus-theme-classic/footer.json +- localization markdown docs: i18n//docusaurus-plugin-content-docs/current/ ### Locale commands To update translation key values: - npm run write-translations -- --locale +npm run write-translations -- --locale + +To updated po4a consolidated .pot and .po files from English markdown files (with po4a tool installed): +po4a po4a.conf --no-translations + +To update localization markdown files from po4a consolidated .po files (with po4a tool installed): +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 -Below is a rough mapping from the old jekyll site i18n strings file fields into the new www/i18n/en/code.json file, for the main page. +Below is a rough mapping from the old Jekyll site i18n strings file fields into the new i18n/en/code.json file, for the main page. - home.subtitle2 = from the top-level title - home.whatisbutterbox = butter_box.device_image_caption