Exporting Markdown

The Markdown export engine translates your visual canvas directly into standard GitHub Flavored Markdown (GFM).

Example Generated Output

Given a diagram named E-Commerce Microservices with an API gateway, order service, database, and Redis cache, Rekhic produces:

markdown Copy
# System Architecture

## Overview
Architecture for E-Commerce Microservices.

## Applications
- **Storefront Web App** (Next.js)

## Services
- **API Gateway** (Kong)
- **Order Service** (Go)

## Data Stores
- **Orders Database** (PostgreSQL)
- **Session Cache** (Redis)

## Relationships / Data Flow
- **Storefront Web App** -> **API Gateway** (*HTTPS /api*)
- **API Gateway** -> **Order Service** (*gRPC*)
- **Order Service** -> **Orders Database** (*SQL queries*)
- **Order Service** -> **Session Cache** (*TCP :6379*)

Where to Use the Exported Markdown

1. ARCHITECTURE.md in Git Roots: Keep an up-to-date high-level architecture specification directly in your source repository root.
2. Pull Request Descriptions: Paste the Markdown summary into major refactor PRs to illustrate changed communication paths.
3. Architecture Decision Records (ADRs): Drop the generated Markdown into your team's docs/adr/ directory to document system topology decisions.

Next: Learn how to integrate this into your development cycle in Documentation Workflow.