Home
Punta BxSites su una cartella docs/ (o src/, se il tuo progetto non è davvero "docs" nello spirito). Ottieni un sito statico veloce e personalizzabile - documentazione, un sito marketing, un blog, o qualsiasi altra cosa il Markdown possa esprimere - completo di ricerca, i18n, e un toolkit Markdown pensato per contenuti reali.
Questo stesso sito è generato da BxSites, a partire dai file Markdown
nella cartella docs/ propria di questo repository.
BxSites non serve solo per la documentazione di riferimento - è un
generatore di siti statici di uso generale. Un sito marketing, un
blog, una knowledge base, un sito prodotto, un sito personale: qualsiasi
cosa tu possa scrivere in Markdown si compila allo stesso modo,
attraverso gli stessi temi, la stessa ricerca e la stessa i18n. I
contenuti vivono in docs/ per impostazione predefinita, o in src/ se
il tuo progetto assomiglia più a un sito web che a "docs" - ogni comando
funziona allo stesso modo in entrambi i casi.
Puntalo su una cartella docs/ - o src/, se il tuo progetto assomiglia
più a un sito web che a "docs" - e genera un sito completo dentro site/,
nessun server necessario per ospitarlo.
Annida cartelle e file sotto docs/ (o src/) e la navigazione si
costruisce da sola, nell'ordine che imposti tramite il frontmatter.
Una galleria completa - bootstrap, material, tailwind, e altri
sette ispirati a Docsy, Stripe, Docusaurus, Just the Docs, VuePress,
GitBook e Notion - tutti sostituibili con un tuo tema personalizzato.
Un box di ricerca basato su MiniSearch (corrispondenza fuzzy, ricerca per prefisso), con in più una palette di comandi
Cmd/Ctrl+K, collegato a un indice di ricerca costruito al momento del
build - nessuna dipendenza da un server.
Deposita i post sotto docs/blog/posts/ e ottieni autori, categorie,
archivi annuali, feed RSS, e immagini in evidenza per post - zero
configurazione richiesta.
Bundling CSS/JS con fingerprint e immagini responsive pronti all'uso, più Bootstrap, highlight.js, Alpine.js, MiniSearch e (opzionale) Mermaid tutti inclusi localmente - un sito compilato non necessita di alcuna richiesta in uscita per default.
Un plugin è semplicemente un altro modulo BoxLang installato - nessuna API di plugin separata da imparare.
install:plugin e install:theme scaricano un pacchetto pubblicato
direttamente nel tuo progetto - sfoglia bxsites-plugins e
bxsites-themes su ForgeBox.
theme:import --source=mkdocs|jekyll|hugo converte i template di un tema
di un altro generatore in uno scaffold bx-sites su cui costruire, invece
di ripartire da zero.
bxSites migrate --from=gitbook|mkdocs|markdown-zip|notion converte un
export o progetto esistente in un progetto bx-sites funzionante con un
unico comando.
bxSites deploy invia il sito compilato direttamente a S3, Azure, GCS,
Firebase, FTP/SFTP, rsync, Netlify, Vercel, Cloudflare Pages, o GitHub
Pages - oppure bxSites package lo comprime in un unico archivio.
{{ dotted.path }} viene preso dal blocco variables proprio di
bxsites.yaml; {{ $name(args) }} richiama un piccolo helper BoxLang
direttamente dal Markdown - senza plugin, senza collegamenti da
configurare.
Tabelle, pulsanti, prompt, espandibili, schede, e specifiche OpenAPI incorporate - una libreria di blocchi in stile GitBook sopra il semplice Markdown.
Vedilo, non limitarti a leggerne
Il toolkit Markdown proprio di BxSites, in azione proprio qui sulla homepage - non uno screenshot, la cosa vera:
install-bx-module bx-sites
bxSites new
bxSites serve
Dodici tipi di ammonizione canonici - note, tip, warning,
danger e altri - ciascuno con il proprio colore d'accento, più una
variante comprimibile ???. Vedi
Estensioni Markdown.
Schede di codice raggruppate, matematica KaTeX, diagrammi Mermaid, note a piè di pagina e liste di definizioni sono tutti disponibili pronti all'uso - vedi Estensioni Markdown.
Dove andare adesso
Installa, genera lo scheletro di un progetto, compilalo e servilo.
Ogni verbo e le sue opzioni.
Il riferimento completo di bxsites.yaml.
Ammonizioni, schede, card, callout, matematica e diagrammi Mermaid.
Post, autori, categorie, archivi, RSS, bozze, e una pagina di statistiche.
Ridimensionamento automatico delle immagini/WebP, e bundling CSS/JS con fingerprint.
deploy/package, e il workflow GitHub Actions integrato.
Politica di versionamento e novità di ogni release.
Serve una mano per costruire il tuo sito?
BxSites è libero e open source - ma se preferisci avere il team che lo sviluppa a fare il lavoro, Ortus Solutions offre servizi professionali e consulenza per siti di documentazione, migrazioni, e qualsiasi altro sito statico costruito con BxSites.