Skip to content

README.md

Latest commit

 

History

History
18 lines (12 loc) · 618 Bytes

README.md

File metadata and controls

18 lines (12 loc) · 618 Bytes
Raw

XFSC Documentation

This repository contains the XFSC documentation about the components, architecture and more.

Rendering docs locally

A Dockerized AsciiDoc toolchain with Mermaid diagram support is available under tools/asciidoctor/. Build the image once, then use it to render any document:

# Build
docker build -t xfsc-asciidoctor tools/asciidoctor/

# Render to HTML
docker run --rm -v "$(pwd)":/documents xfsc-asciidoctor \
  asciidoctor -r asciidoctor-diagram path/to/document.adoc

See the full README for PDF output and more examples.