Bricks2Etch – public documentation (Docusaurus)

This repository contains the Docusaurus site for Bricks2Etch user documentation, deployable to GitHub Pages (project site) at e.g.:

https://<github-username>.github.io/bricks2etch-docs/

Languages

Locale	Role	Source path
en (default)	Primary language	docs/*.md / docs/intro.mdx
de	Second language	i18n/de/docusaurus-plugin-content-docs/current/*

The language switcher is in the navbar (Docusaurus localeDropdown). To adjust German UI labels (nav/footer), edit i18n/de/docusaurus-theme-classic/*.json. After changing English strings in docusaurus.config.ts, run:

npm run write-translations -- --locale de

and merge or translate the new keys in the generated i18n/de/code.json if needed.

Page map (file names = URL slugs, English)

Page	docs/ file
Introduction	intro.mdx (home, slug: /)
Requirements	requirements.md
Installation	installation.md
Migration workflow	workflow.md
What gets migrated?	what-gets-migrated.md
Offline (ZIP) import	offline-zip-import.md
Hosting notes	hosting.md
Limits & expectations	limitations.md
Who is it for?	who-is-it-for.md
Resources & technical docs	resources.md

Content is aligned with the Bricks2Etch product (README/FAQ-style notes, migration scope, etc.).

Requirements

• Node.js 20+
• npm

Local development

cd E:\Github\bricks2etch-docs
npm install
npm start

Open the URL from the terminal (default http://localhost:3000/ — English at /, German at /de/). Keep the process running while you work.

Issue	What to do
ERR_CONNECTION_REFUSED	Start npm start in this folder; keep the terminal open.
Wrong folder	Run commands inside bricks2etch-docs, not your separate plugin project folder.
Port in use	Use the port printed by Docusaurus.

Production build: use npm run build so baseUrl and i18n output match GitHub Pages (do not call docusaurus build without the npm NODE lifecycle in odd setups).

New GitHub repository

1. Create a new public repo, e.g. bricks2etch-docs (no README if you already have files here).

2. Set GITHUB_USER / REPO_NAME in docusaurus.config.ts to match the repo owner and name, then:

   git remote add origin https://github.com/<USER>/bricks2etch-docs.git
   git push -u origin main

3. Settings → Pages → Build and deployment → GitHub Actions (workflow in .github/workflows/deploy.yml).

4. If the repo name is not bricks2etch-docs, set REPO_NAME in docusaurus.config.ts to match the GitHub project segment in the Pages URL.

Etch referral: set your full etchwp affiliate URL in docusaurus.config.ts as ETCH_REF_URL (used for navbar, footer, and the Etch line on the intro page).

License

Align content licensing with your project; the Bricks2Etch plugin is licensed separately from this documentation site.