butter/likebutter.app
7
0
Fork 0
Code Issues 4 Pull requests Projects Releases Packages Wiki Activity Actions
likebutter.app/README.md
n8fr8 e2960f171f update README
2026-04-24 10:06:17 -04:00

1.7 KiB
Raw Permalink Blame History

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 www/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/

Locale commands

To update translation key values: npm run write-translations -- --locale

To run the site in a specific locale: npm run start -- --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 www/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