Home

BX Sites

BX Sites è un modulo BoxLang che genera siti di documentazione statici a partire da Markdown, nello spirito di mkdocs e mkdocs-material.

Questo stesso sito è generato da BX Sites, a partire dai file Markdown nella cartella docs/ di questo repository - vedi Per iniziare per compilarlo tu stesso.

In evidenza

• Markdown in ingresso, HTML statico in uscita. Puntalo su una cartella docs/ e genera un sito completo dentro site/ - nessun server necessario per ospitarlo.
• La struttura delle cartelle è la struttura di navigazione. Annida cartelle e file sotto docs/ e la navigazione si costruisce da sola, nell'ordine che imposti tramite il frontmatter.
• Tre temi integrati. bootstrap (predefinito), material e tailwind - tutti condividono la stessa palette del brand BoxLang, e tutti sono sostituibili con un tuo tema personalizzato.
• Ricerca statica lato client. Un box di ricerca basato su lunr.js, collegato a un indice di ricerca costruito al momento del build - lo stesso approccio che usa mkdocs stesso di default, senza alcuna dipendenza da un server.
• Markdown gestito da bx-markdown. BX Sites non analizza il Markdown da sé; delega il compito a bx-markdown e inoltra direttamente a esso le tue opzioni di bxsites.json.
• Un sistema di plugin costruito sul sistema di moduli di BoxLang. Un plugin è semplicemente un altro modulo BoxLang installato - nessuna API di plugin separata da imparare.
• Migra direttamente da GitBook o mkdocs. bxSites migrate --source=... --from=gitbook|mkdocs converte un export di GitBook o un progetto mkdocs esistente in un progetto bx-sites funzionante con un unico comando.

Dove andare adesso

• Per iniziare - installa, genera lo scheletro di un progetto, compilalo e servilo
• Riferimento CLI - ogni verbo e le sue opzioni
• Configurazione - il riferimento completo di bxsites.json
• Temi - i temi integrati e come scriverne uno tuo
• Ricerca - come funziona l'indice di ricerca statico
• Distribuire su GitHub Pages - il workflow GitHub Actions integrato
• Estensioni Markdown - ammonizioni, note a piè di pagina, liste di definizioni, schede di contenuto, matematica, annotazioni del codice e diagrammi Mermaid
• Plugin - estendere BX Sites con un tuo modulo BoxLang
• Migrare da GitBook - convertire un export di GitBook in un progetto bx-sites con un solo comando
• Migrare da mkdocs - convertire un progetto mkdocs in un progetto bx-sites con un solo comando
• Release - politica di versionamento e novità di ogni release