Skip to content
EKGFPublic

About

A tool to generate documentation for a given graph (knowledge graph, shape graph or ontology) as website or PDF

Resources

Contributing

Stars

5 stars

Watchers

3 watching

Forks

Latest commit

 

History

136 Commits

Folders and files

Repository files navigation

GraphArch

Docs CI Build Documentation License

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 are published on GitHub Releases. Package-manager channels have separate publication requirements; see the installation guide for their availability.

To build in GitHub Actions:

- uses: actions/checkout@v7
- uses: EKGF/grapharch@v0.1.0
  with:
    version: '0.1.0'
    source-kind: checkout

See GitHub Actions for configuration and Pages publication.

After installation:

grapharch --version
grapharch publication --help

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.

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.

About

A tool to generate documentation for a given graph (knowledge graph, shape graph or ontology) as website or PDF

Resources

Contributing

Stars

5 stars

Watchers

3 watching

Forks

Releases

Packages

Used by

Contributors

Languages