README to Diagram

Rekhic can analyze existing project documentation (README.md) and automatically generate an editable system architecture diagram on your canvas.

What It Does

Most software repositories already document their high-level design in their README.md using:

Mermaid diagrams (mermaid code blocks with graph or flowchart).
Markdown structural headings (e.g. ## Architecture, ## System Design, ## Components).
Technology mentions (e.g. PostgreSQL, Redis, Kafka, Docker).

Rekhic extracts these structures, detects component boundaries and relationships, and scaffolds a clean, interactive canvas diagram so you don't have to build it manually from scratch.

Supported Inputs

You can import documentation into Rekhic using two methods at /import/readme:

Pasted Markdown Text: Paste raw README markdown directly into the text editor.
File Upload: Upload any .md or .markdown file directly from your local filesystem.
Supported Mermaid Diagrams:
- graph TD / graph TB (Top-to-Bottom flowcharts)
- graph LR (Left-to-Right flowcharts)
- flowchart TD / flowchart LR
- Node shapes, bracket syntax ([Service], [(Database)], ([Process])), and labeled arrows (-->|protocol|).

The Workflow

text
  README (Pasted or .md Upload)
               │
               ▼
   Local Client-Side Analyzer
 (Mermaid Parser & Section Extractor)
               │
               ▼
     Architecture Preview
 (Interactive Preview & Summary Stats)
               │
               ▼
       Open in Rekhic Canvas
 (Fully editable nodes, icons & edges)

Select Input: Go to Generators -> README (/import/readme).
Provide Content: Paste your README or drop a file. You can also click Load Sample to inspect a pre-formatted microservices example.
Analyze: Click Analyze README. Rekhic processes the text in milliseconds directly within your browser.
Inspect Architecture Preview: Review the detected components, data stores, and relationships in the side-by-side preview pane.
Open in Canvas: Click Open in Canvas. Rekhic initializes a new workspace where all detected components and connectors become fully editable nodes.

Generated Diagrams Remain 100% Editable

The resulting diagram is not a static image:

Every service is an interactive Architecture Node.
Every relationship is a routed Connector Edge.
You can move nodes, add missing cloud infrastructure, recolor components, apply icons, and run Auto Layout.

Privacy: 100% Local Processing

Your README content is parsed and processed strictly in your local browser runtime. It is never sent to or stored on any Rekhic backend servers.

Next: Learn how to analyze source code in Code to Diagram.

Selection & Grouping

Code to Diagram