GraphArch

Turn authored text, ontologies, shapes, and related RDF into a documentation knowledge graph, then publish a specification, companion website, or PDF.

GraphArch is one command-line tool. Keep your content and publication configuration in your project; use the same command locally and in CI.

Get started

Use a prebuilt release for normal use. Download the archive for your platform from GitHub Releases, extract it, and put grapharch (or grapharch.exe) on your PATH.

Standalone binaries and the crates.io package are published. With cargo-binstall installed, cargo binstall grapharch --version 0.2.4 installs the prebuilt executable. See the installation guide for Python/npm commands and the published versions available from each registry.

To build in GitHub Actions:

- uses: actions/checkout@v7
- uses: EKGF/grapharch@<release-commit-sha> # vX.Y.Z
  with:
    source-kind: checkout

The action installs the verified release of the commit it is referenced by, so Dependabot upgrades GraphArch by changing that one line.

See GitHub Actions for configuration and Pages publication.

Building OWL class diagrams also requires a local Java and PlantUML installation. The repository’s GitHub Action provisions the pinned renderer explicitly; ordinary Markdown builds and rendering a retained graph do not need it. See OWL class diagrams for the dependency contract.

After installation:

grapharch --version
grapharch build ./ontology.ttl
# Or discover Markdown and RDF in the current directory:
grapharch build .

Open output/grapharch/site/index.html. No configuration or frontmatter is required; GraphArch keeps the collected documentation graph alongside the site. Add publication configuration when you need specific branding, scopes, or outputs.

Follow Getting started for installation options and your first publication. See the showcase gallery for generated HTML, PDFs, and downloadable documentation graphs.

Publish your documentation

GraphArch can read a directory, a local Git checkout including your edits, or a remote Git repository. Your publication definitions select the content, publishing authority, style, and outputs.

• Publish an ontology family.
• Publish a specification, companion website, and PDF.
• Generate a documentation website.

The same pipeline works with your own ontologies, repositories, and publishing authority. EKGF ontologies and DPROD are examples, alongside the other executable showcases.

Build from source

This is for contributors and people testing unreleased changes. Install the development prerequisites, then run:

git clone https://github.com/EKGF/grapharch.git
cd grapharch
cargo build --release --locked
./target/release/grapharch --help

On Windows, run target\release\grapharch.exe --help after the build. See Contributing for development guidance and the implementation status for current limits.

License

GraphArch is available under the MIT license. Bundled reference sources and fonts retain their own licenses.