Startseite

BX Sites

BX Sites ist ein BoxLang-Modul, das statische Dokumentations-Websites aus Markdown erzeugt, im Geiste von mkdocs und mkdocs-material.

Genau diese Seite wird von BX Sites gebaut, aus den Markdown-Dateien im docs/-Ordner dieses Repositorys - sieh dir Erste Schritte an, um sie selbst zu bauen.

Highlights

• Markdown rein, statisches HTML raus. Zeig auf einen docs/-Ordner und es entsteht eine komplette Website in site/ - kein Server nötig, um sie zu hosten.
• Ordnerstruktur ist Navigationsstruktur. Verschachtele Ordner und Dateien unter docs/, und die Navigation baut sich von selbst auf, in der Reihenfolge, die du per Frontmatter festlegst.
• Drei integrierte Themes. bootstrap (das Standard-Theme), material und tailwind - alle mit derselben BoxLang-Markenpalette, und alle mit deinem eigenen Theme überschreibbar.
• Statische, clientseitige Suche. Eine mit lunr.js betriebene Suchbox, verdrahtet mit einem beim build erstellten Suchindex - derselbe Ansatz, den mkdocs selbst standardmäßig verwendet, ohne Server-Abhängigkeit.
• Markdown wird von bx-markdown verarbeitet. BX Sites parst Markdown nicht selbst; es delegiert an bx-markdown und reicht deine eigenen bxsites.json-Optionen direkt daran weiter.
• Ein Plugin-System, das auf BoxLangs eigenem Modulsystem aufbaut. Ein Plugin ist einfach ein weiteres installiertes BoxLang-Modul - keine separate Plugin-API zu lernen.
• Direkte Migration aus GitBook oder mkdocs. bxSites migrate --source=... --from=gitbook|mkdocs wandelt einen bestehenden GitBook-Export oder ein mkdocs-Projekt mit einem Befehl in ein funktionierendes bx-sites-Projekt um.

Wie geht es weiter

• Erste Schritte - installieren, ein Projekt aufsetzen, bauen und ausliefern
• CLI-Referenz - jedes Verb und seine Optionen
• Konfiguration - die vollständige bxsites.json-Referenz
• Themes - die integrierten Themes und wie du dein eigenes schreibst
• Suche - wie der statische Suchindex funktioniert
• Deployment auf GitHub Pages - der integrierte GitHub-Actions-Workflow
• Markdown-Erweiterungen - Admonitions, Fußnoten, Definitionslisten, Content-Tabs, Mathematik, Code-Annotationen und Mermaid-Diagramme
• Content-Blöcke - GitBook-artige Blöcke: Expandables, Cards, Columns, ein Stepper und wiederverwendbare Content-Includes
• Responsive Bilder - automatische Skalierung, WebP-Varianten und CSS-/JS-Bundling, standardmäßig aktiv
• Interaktivität mit Alpine.js - reaktiver Inhalt ganz ohne zusätzliches Setup
• Blog - ein Convention-over-Configuration-Blog: Beiträge, Autoren, Kategorien, Archive, RSS und Statistiken
• Plugins - BX Sites mit einem eigenen BoxLang-Modul erweitern
• Versionierung - die Docs einer Version einfrieren und kostenlos einen Versionsumschalter erhalten
• Internationalisierung (i18n) - deine Docs in andere Sprachen übersetzen
• Migration von GitBook - einen GitBook-Export mit einem Befehl in ein bx-sites-Projekt umwandeln
• Migration von mkdocs - ein mkdocs-Projekt mit einem Befehl in ein bx-sites-Projekt umwandeln
• Beratung & Professionelle Dienstleistungen - Docs- und Static-Site-Beratung von Ortus Solutions
• Releases - Versionierungsrichtlinie und Neuigkeiten pro Release