Das Support-Wiki der smart-me AG als Docusaurus-Site.
Es löst das bisherige Google-Sites-Wiki (dok.smart-me.com) ab und dient
zugleich als Datenquelle für AI-Tools (Markdown im Repo + llms.txt).
Deutsch ist die Master-Sprache. Alle Inhalte werden ausschliesslich unter
docs/ auf Deutsch gepflegt. Englisch, Französisch und Italienisch entstehen
automatisch über die Übersetzungs-Pipeline.
Die Ordner unter
i18n/werden nie von Hand bearbeitet – siehe CONTRIBUTING.md.
- Node.js >= 20 (getestet mit 22)
- npm 10+
npm install
npm startDie Site läuft danach auf http://localhost:3000. npm start zeigt nur die
deutsche Fassung. Eine andere Sprache prüfst du mit:
npm run start -- --locale frnpm run buildDer Build bricht bei defekten internen Links ab (onBrokenLinks: 'throw').
| Pfad | Inhalt |
|---|---|
docs/ |
Alle Inhalte auf Deutsch (Master) |
i18n/<locale>/ |
Generierte Übersetzungen – nicht von Hand pflegen |
static/img/<seiten-slug>/ |
Bilder, nach Seite gruppiert |
src/components/ |
Eigene MDX-Komponenten (z.B. <Video>) |
src/css/tokens.css |
Design Tokens, unverändert aus den Design Guidelines |
src/css/custom.css |
Zuordnung der Tokens auf Docusaurus |
sidebars.ts |
Navigationsstruktur |
redirects.ts |
Weiterleitungen von den alten Google-Sites-URLs |
scripts/ |
Migrations- und Übersetzungsskripte |
glossary.md |
Begriffe für die Übersetzung (fixe Übersetzungen, Produktnamen) |
plugins/llms-txt/ |
Erzeugt llms.txt und llms-full.txt je Sprache |
migration-report.md |
Protokoll der Migration inkl. offener Punkte |
Die Gestaltung folgt den smart-me Design Guidelines
(design-guidelines/smart-me/design.md, Quelle: internes Design Wiki):
- Primärfarbe smart-me Blau
#28599A, Grün als unterstützende Farbe - Weiss als Grundfläche, Blau 5 % (
#F4F6FA) für ruhige Flächen - Schrift Noto Sans (400/500/700), selbst ausgeliefert über
@fontsource - Überschriften in smart-me Blau, Fliesstext
#272727, linksbündig - Links im Fliesstext immer unterstrichen
- Semantische Farbquartette für Hinweise, Warnungen und Fehler
src/css/tokens.css ist eine unveränderte Kopie der tokens.css aus den
Guidelines und sollte nur bei einer Aktualisierung dort angefasst werden. Die
Abbildung auf die Variablen von Docusaurus steht in src/css/custom.css.
Offen: Der Dark Mode ist in den Guidelines nicht beschrieben – er verwendet hier hellere Stufen derselben Blau-Rampe. Ebenso ist kein Favicon definiert; aktuell dient die Wortmarke als Platzhalter. Beides gehört vor dem Produktivgang zu design@smart-me.com.
Der Build legt pro Sprache zwei Dateien nach dem Vorschlag von llmstxt.org ab:
| Datei | Inhalt |
|---|---|
/llms.txt |
Inhaltsverzeichnis mit einer Beschreibung je Seite |
/llms-full.txt |
Volltext aller Seiten am Stück |
Für die anderen Sprachen unter /en/llms.txt, /fr/llms.txt, /it/llms.txt.
Dazu kommt die übliche /sitemap.xml. Der Markdown-Quelltext im Repository ist
ebenfalls direkt verwendbar.
Jeder Push auf main baut die Site und veröffentlicht sie über
.github/workflows/deploy.yml auf GitHub Pages. Einmalig muss unter
Settings → Pages die Quelle auf GitHub Actions gestellt werden.
Die Site wird auf GitHub Pages veröffentlicht. Für den Wechsel auf
dok.smart-me.com genügen zwei Anpassungen: static/CNAME anlegen und in
docusaurus.config.ts url/baseUrl setzen (bzw. die Umgebungsvariablen
SITE_URL und BASE_URL).