Startseite
Zeig auf einen docs/-Ordner (oder src/, wenn dein Projekt inhaltlich gar nicht "docs" ist). Erhalte eine schnelle, themefähige statische Website daraus - Dokumentation, eine Marketing-Site, ein Blog, oder alles andere, was sich in Markdown ausdrücken lässt - komplett mit Suche, i18n und einem Markdown-Toolkit für echten Content.
Genau diese Seite wird von BxSites gebaut, aus den Markdown-Dateien im
docs/-Ordner dieses Repositorys.
BxSites ist nicht nur für Referenzdokumentation gedacht - es ist ein
allgemeiner statischer Site-Generator. Eine Marketing-Site, ein Blog,
eine Wissensdatenbank, eine Produktseite, eine persönliche Seite: alles, was
sich in Markdown schreiben lässt, wird auf demselben Weg gebaut - mit
denselben Themes, derselben Suche und demselben i18n. Der Content liegt
standardmäßig unter docs/, oder unter src/, wenn dein Projekt
inhaltlich eher eine Website als "docs" ist - jeder Befehl funktioniert in
beiden Fällen gleich.
Zeig auf einen docs/-Ordner - oder src/, wenn dein Projekt eher wie
eine Website als wie "docs" wirkt - und es entsteht eine komplette Website
in site/, kein Server nötig, um sie zu hosten.
Verschachtele Ordner und Dateien unter docs/ (oder src/), und die Navigation baut
sich von selbst auf, in der Reihenfolge, die du per Frontmatter festlegst.
Eine vollständige Galerie - bootstrap, material, tailwind und sieben
weitere, inspiriert von Docsy, Stripe, Docusaurus, Just the Docs, VuePress,
GitBook und Notion - alle mit deinem eigenen Theme überschreibbar.
Eine MiniSearch-basierte Suchbox (unscharfe Treffer, Präfixsuche) plus eine Cmd/Ctrl+K-Befehlspalette,
verdrahtet mit einem beim build erstellten Suchindex - ohne
Server-Abhängigkeit.
Lege Beiträge unter docs/blog/posts/ ab und erhalte Autoren, Kategorien,
Jahresarchive, RSS-Feeds und Featured Images pro Beitrag - ganz ohne
Konfiguration.
Fingerprinted CSS/JS-Bundling und responsive Bilder direkt eingebaut, dazu Bootstrap, highlight.js, Alpine.js, MiniSearch und (optional) Mermaid alle vendored - eine gebaute Website benötigt standardmäßig keine ausgehenden Anfragen.
Ein Plugin ist einfach ein weiteres installiertes BoxLang-Modul - keine separate Plugin-API zu lernen.
install:plugin und install:theme laden ein veröffentlichtes Paket
direkt in dein Projekt herunter - durchsuche bxsites-plugins und
bxsites-themes auf ForgeBox.
theme:import --source=mkdocs|jekyll|hugo wandelt die eigenen
Theme-Templates eines anderen Generators in ein bx-sites-Gerüst um, auf
dem du aufbauen kannst - statt bei null anzufangen.
bxSites migrate --from=gitbook|mkdocs|markdown-zip|notion wandelt einen
bestehenden Export oder ein Projekt mit einem Befehl in ein funktionierendes
bx-sites-Projekt um.
bxSites deploy liefert die gebaute Website direkt an S3, Azure, GCS,
Firebase, FTP/SFTP, rsync, Netlify, Vercel, Cloudflare Pages oder GitHub
Pages aus - oder bxSites package packt sie stattdessen in ein einzelnes
Archiv.
{{ dotted.path }} greift auf den eigenen variables-Block der
bxsites.yaml zu; {{ $name(args) }} ruft direkt aus Markdown heraus einen
kleinen BoxLang-Helper auf - kein Plugin, keine Verdrahtung nötig.
Tabellen, Buttons, Prompts, Expandables, Tabs und eingebettete OpenAPI-Spezifikationen - eine GitBook-artige Block-Bibliothek auf Basis von reinem Markdown.
Selbst sehen, statt nur davon lesen
BxSites' eigenes Markdown-Toolkit in Aktion, direkt hier auf der Startseite - kein Screenshot, das Original:
install-bx-module bx-sites
bxSites new
bxSites serve
Zwölf kanonische Admonition-Typen - note, tip, warning, danger
und mehr - jeder mit eigener Akzentfarbe, dazu eine einklappbare
???-Variante. Siehe
Markdown-Erweiterungen.
Gruppierte Code-Tabs, KaTeX-Mathematik, Mermaid-Diagramme, Fußnoten und Definitionslisten sind alle direkt eingebaut - siehe Markdown-Erweiterungen.
Wie geht es weiter
Installieren, ein Projekt aufsetzen, bauen und ausliefern.
Jedes Verb und seine Optionen.
Die vollständige bxsites.yaml-Referenz.
Admonitions, Tabs, Cards, Callouts, Mathematik und Mermaid-Diagramme.
Beiträge, Autoren, Kategorien, Archive, RSS, Entwürfe und eine Statistikseite.
Automatische Bildskalierung/WebP und fingerprinted CSS/JS-Bundling.
deploy/package und der integrierte GitHub-Actions-Workflow.
Versionierungsrichtlinie und Neuigkeiten pro Release.
Brauchst du Hilfe beim Aufbau deiner Website?
BxSites ist frei und Open Source - aber wenn du lieber das Team, das es entwickelt, die Arbeit machen lassen möchtest, bietet Ortus Solutions professionelle Dienstleistungen und Beratung für Dokumentations-Websites, Migrationen und jede andere mit BxSites gebaute statische Website an.