butter/likebutter.app
7
0
Fork 0
Code Issues 5 Pull requests Projects Releases Packages Wiki Activity Actions
New website for Butter Box built with Docusaurus https://likebutter.app/
88 commits 1 branch 0 tags 105 MiB
Find a file
luxferre 43c0435525 fix: final report path 
Links to files need `pathname:///` prefix in the path.

(cherry picked from commit 3d0d12ed2e)
2026-05-01 16:16:37 +01:00
.forgejo/workflows ci: build and publish 2026-04-28 13:34:46 +01:00
blog fix: final report path 2026-05-01 16:16:37 +01:00
contentpack feat: content pack category 2026-04-29 14:39:35 +01:00
docs fix: more brackets in file names 2026-05-01 16:16:24 +01:00
i18n i18n: po4a changes for previous patch 2026-05-01 16:16:37 +01:00
po4a i18n: po4a changes for previous patch 2026-05-01 16:16:37 +01:00
src feat: hero text change 2026-05-01 16:15:44 +01:00
static fix: final report path 2026-05-01 16:16:37 +01:00
.gitignore add .idea to gitignore 2026-04-30 13:14:29 +01:00
.gitlab-ci.yml fix gitlab ci 2026-04-25 09:12:09 -04:00
docusaurus.config.ts feat: content pack category 2026-04-29 14:39:35 +01:00
LICENSE add readme and license 2026-04-21 19:03:37 -04:00
package-lock.json feat: content pack category 2026-04-29 14:39:35 +01:00
package.json feat: content pack category 2026-04-29 14:39:35 +01:00
po4a.conf feat: po4a conf 2026-04-24 16:39:24 +01:00
README.md feat: readme update 2026-05-01 16:15:44 +01:00
sidebars.ts feat: refactor to remove www 2026-04-24 16:39:24 +01:00
tsconfig.json feat: refactor to remove www 2026-04-24 16:39:24 +01:00

README.md

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.

Localization

All localizations (currently en, es, ru and zh-Hans) are under the i18n/ folder structure

Key files for localization are:

  • 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 <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 <locale> --overrride

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 <locale>

To build the static site for all locales:

npm run build

Localization mapping

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
  • home.section1.title = butter_box.explanation_header
  • home.section1.description = butter_box.explanation
  • home.learnmore = butter_box.learn_more
  • home.getbutter.title = butter_box.get_your_own_header
  • home.getbutter.description = butter_box.get_your_own
  • home.getintouch = butter_box.contact_cta
  • home.makebutter.title = butter_box.make_your_own_header
  • home.makebutter.description = butter_box.make_your_own
  • home.getcode.title = butter_box.make_your_own_from_scratch
  • home.getsource.button = butter_box.repo_cta