justinwalsh/daux.io
Daux.io
Este proyecto es un generador de sitios estáticos y servidor de documentación basado en Markdown que convierte archivos y estructuras de carpetas en sitios web responsivos. Funciona como un editor de documentación para Confluence, permitiendo la carga directa y sincronización de contenido Markdown procesado hacia servidores de bases de conocimiento empresariales.
El sistema se distingue por sus capacidades de renderizado técnico, transformando sintaxis Mermaid en diagramas visuales y expresiones TeX en fórmulas matemáticas. Soporta documentación multilingüe creando versiones localizadas de un sitio con estructuras de navegación dedicadas.
La plataforma proporciona un pipeline de contenido completo que incluye menús de navegación jerárquicos, resaltado de sintaxis de código y un sistema para gestionar el orden de las páginas mediante prefijos en los nombres de archivo. También cuenta con un framework de extensibilidad flexible para generadores de contenido personalizados y manipulación programática del árbol de páginas.
El entorno puede desplegarse como un contenedor Docker portátil e incluye un servidor de vista previa local para probar la documentación antes de la generación final.
Features
- Static Documentation Generators - Transforms structured Markdown files and directory hierarchies into a responsive static documentation website.
- Markdown Renderers - Converts Markdown syntax into structured HTML to create a responsive static documentation website.
- Static Site Generators - Provides a system that compiles Markdown and folder structures into a responsive static documentation website.
- Hierarchical Navigation Menus - Transforms directory structures and file naming conventions into a structured, hierarchical navigation menu.
- Confluence Publishers - Acts as a dedicated publisher for processing Markdown and uploading it directly to Confluence servers.
- Confluence Synchronization - Enables direct upload and synchronization of processed Markdown content to enterprise Confluence servers.
- Technical Content Renderers - Renders complex technical content including mathematical formulas via TeX, Mermaid diagrams, and syntax-highlighted code.
- Confluence Managers - Provides a system for publishing and managing processed Markdown documentation directly on Confluence servers.
- Content Pipelines - Provides a programmable pipeline of classes to transform markdown source into structured web pages.
- Mermaid Diagram Renderers - Transforms human-readable Mermaid syntax into visual flowcharts and diagrams within the documentation.
- Developer Documentation - Provides a developer-centric workflow for transforming Markdown files and folder hierarchies into structured technical guides.
- Folder-to-Navigation Mapping - Translates nested directory structures and filenames directly into a hierarchical website navigation system.
- Extension-Based Generators - Uses a registry of generators to convert various file extensions into rendered HTML content.
- Multi-Format Document Exports - Exports a single source of documentation into multiple formats, including standalone HTML and external platform uploads.
- Multi-Language Websites - Creates localized versions of the documentation site using separate directories for different languages.
- Multilingual Documentation - Supports the management and serving of technical content in multiple languages with dedicated navigation.
- Prefix-Based Sequence Ordering - Determines navigation link order by parsing filename prefixes to override default alphabetical sorting.
- Dynamic Page Renderings - Generates website pages on the fly by scanning the source directory during each incoming HTTP request.
- Incremental Sync - Optimizes updates by synchronizing only the changes that occur between the source and destination.
- Content Synchronizers - Implements differential synchronization to upload only modified pages to external knowledge bases.
- Automatic Table of Contents - Automatically generates navigational outlines and lists of links based on the document's heading hierarchy.
- Local Site Previews - Runs a local server to preview rendered documentation and test the site before final generation.
- Diagram Pre-rendering - Converts Mermaid diagrams into images before publishing to avoid rendering failures.
- Docker Image Packaging - Bundles the documentation and environment into a portable Docker image for simplified deployment.
- Document Server Containers - Provides a portable Docker environment that serves Markdown-based documentation as a live website.
- Mathematical Expression Rendering - Renders TeX expressions into visual mathematical formulas for technical documentation.
- Page Orderings - Controls the sequence of navigation links using filename prefixes to override default alphabetical sorting.
- Multilingual Site Support - Creates localized versions of the documentation site with dedicated navigation structures for different languages.
- Code Syntax Highlighting - Applies visual formatting and colors to code blocks based on language syntax rules.
- Document Theme Templates - Injects processed content into predefined CSS and HTML layouts based on configured document themes.
- Internal Page Link Resolvers - Maps relative Markdown links to valid functional paths within the generated website structure.
- Static Site Search Indices - Implements an embedded search engine with a static index for client-side content discovery.
- On-the-Fly Compilation - Transforms source files into browser-ready HTML in real-time during the HTTP request cycle.
- Pretty URL Generation - Generates clean, extensionless URLs by mapping directory structures to index files.
