Inicio
Apunta BxSites a una carpeta docs/ (o src/, si tu proyecto no es realmente "docs" en espíritu). Obtén un sitio estático rápido y personalizable - documentación, un sitio de marketing, un blog o cualquier otra cosa que Markdown pueda expresar - completo con búsqueda, i18n y un conjunto de herramientas Markdown pensado para contenido real.
Este mismo sitio está construido con BxSites, a partir de los archivos
Markdown en la propia carpeta docs/ de este repositorio.
BxSites no es solo para documentación de referencia - es un
generador de sitios estáticos de propósito general. Un sitio de
marketing, un blog, una base de conocimiento, un sitio de producto, un sitio
personal: todo lo que puedas escribir en Markdown se construye de la misma
forma, a través de los mismos temas, búsqueda e i18n. El contenido vive en
docs/ por defecto, o en src/ si tu proyecto se parece más a un sitio
web que a "docs" - cada comando funciona igual en ambos casos.
Apúntalo a una carpeta docs/ - o src/, si tu proyecto se parece más a
un sitio web que a "docs" - y genera un sitio completo en site/, sin
necesidad de servidor para alojarlo.
Anida carpetas y archivos bajo docs/ (o src/) y la navegación se
construye sola, en el orden que definas mediante el frontmatter.
Una galería completa - bootstrap, material, tailwind y siete más
inspirados en Docsy, Stripe, Docusaurus, Just the Docs, VuePress, GitBook y
Notion - todos sobrescribibles con tu propio tema.
Un cuadro de búsqueda impulsado por MiniSearch (coincidencia difusa, búsqueda por prefijo), más una paleta de comandos
Cmd/Ctrl+K, conectado a un índice de búsqueda generado en el momento de
build - sin dependencia de servidor.
Coloca entradas bajo docs/blog/posts/ y obtén autores, categorías,
archivos anuales, feeds RSS e imágenes destacadas por entrada - sin
configuración necesaria.
Empaquetado de CSS/JS con huella digital e imágenes responsivas listos de fábrica, además de Bootstrap, highlight.js, Alpine.js, MiniSearch y (opcional) Mermaid, todos incluidos localmente - un sitio construido no necesita ninguna solicitud saliente por defecto.
Un plugin es simplemente otro módulo de BoxLang instalado - no hay una API de plugins separada que aprender.
install:plugin e install:theme descargan un paquete publicado
directamente a tu proyecto - explora bxsites-plugins y bxsites-themes
en ForgeBox.
theme:import --source=mkdocs|jekyll|hugo convierte las propias plantillas
de tema de otro generador en un scaffold de bx-sites sobre el que construir,
en lugar de empezar desde cero.
bxSites migrate --from=gitbook|mkdocs|markdown-zip|notion convierte una
exportación o proyecto existente en un proyecto bx-sites funcional con un
solo comando.
bxSites deploy envía el sitio construido directamente a S3, Azure, GCS,
Firebase, FTP/SFTP, rsync, Netlify, Vercel, Cloudflare Pages o GitHub
Pages - o bxSites package lo empaqueta en un único archivo.
{{ dotted.path }} toma valores del propio bloque variables de
bxsites.yaml; {{ $name(args) }} llama a un pequeño ayudante de
BoxLang directamente desde Markdown - sin plugin, sin cableado alguno.
Tablas, botones, prompts, expandibles, pestañas y especificaciones OpenAPI incrustadas - una biblioteca de bloques al estilo GitBook sobre Markdown puro.
Míralo, no solo leas sobre ello
El propio conjunto de herramientas Markdown de BxSites, en acción aquí mismo en la página de inicio - no es una captura de pantalla, es lo real:
install-bx-module bx-sites
bxSites new
bxSites serve
Doce tipos de admonición canónicos - note, tip, warning, danger
y más - cada uno con su propio color de acento, además de una variante
colapsable ???. Consulta
Extensiones de Markdown.
Pestañas de código agrupadas, matemáticas con KaTeX, diagramas Mermaid, notas al pie y listas de definiciones, todo incluido de fábrica - consulta Extensiones de Markdown.
A dónde ir a continuación
Instala, crea un proyecto, constrúyelo y sírvelo.
Todos los verbos y sus opciones.
La referencia completa de bxsites.yaml.
Admoniciones, pestañas, tarjetas, callouts, matemáticas y diagramas Mermaid.
Entradas, autores, categorías, archivos, RSS, borradores y una página de estadísticas.
Redimensionado automático de imágenes/WebP, y empaquetado de CSS/JS con huella digital.
deploy/package, y el flujo de trabajo de GitHub Actions incorporado.
Política de versionado y novedades de cada lanzamiento.
¿Necesitas ayuda para construir tu sitio?
BxSites es libre y de código abierto - pero si prefieres que el equipo que lo construye haga el trabajo, Ortus Solutions ofrece servicios profesionales y consultoría para sitios de documentación, migraciones y cualquier otro sitio estático construido con BxSites.