# n8n-io/n8n-docs architecture

> Architecture diagram of the GitHub repository n8n-io/n8n-docs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/n8n-io/n8n-docs
- Repository: https://github.com/n8n-io/n8n-docs

## Overview

##### Main Components

a. Content Layer:
- Documentation content (Markdown files in `/docs`)
- Snippets system (`/_snippets`)
- Templates (`/document-templates`)
- Glossary (`/_glossary`)
- Images and media assets (`/docs/_images`)
- Video content (`/docs/_video`)
- Example workflows (`/docs/_workflows`)

b. Build System:
- MkDocs engine
- Custom theme overrides (`/_overrides`)
- Style configurations (`/styles`)
- Build configuration (`mkdocs.yml`)

c. Integration Layer:
- GitHub Actions workflows (`.github/workflows`)
- Vale linting system (`.vale.ini`)
- Python dependencies management

##### Relationships and Data Flow

**[Content Layer] → [Build System] → [Static Site Output]**
- ↑
**[Style System] -┘**
- ↑
**[CI/CD Pipeline]-┘**

##### Component Details

For each major component, include:
- Input/output relationships
- Configuration dependencies
- File type handling capabilities
- Integration points with external systems

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Content
        DC["Documentation Content"]:::content
        SN["Snippets System"]:::content
        DT["Document Templates"]:::content
        GL["Glossary System"]:::content
        MA["Media Assets"]:::content
        VC["Video Content"]:::content
        EW["Example Workflows"]:::content
    end

    subgraph BuildSystem
        ME["MkDocs Engine"]:::build
        TO["Theme Overrides"]:::build
        SC["Style System"]:::build
        BC["Build Config"]:::build
    end

    subgraph Integration
        GH["GitHub Actions"]:::integration
        VL["Vale Linting"]:::integration
        PD["Python Dependencies"]:::integration
    end

    subgraph Output
        SS["Static Site"]:::output
    end

    %% Content Layer Relationships
    DC --> ME
    SN --> DC
    DT --> DC
    GL --> DC
    MA --> DC
    VC --> DC
    EW --> DC

    %% Build System Relationships
    TO --> ME
    SC --> ME
    BC --> ME
    ME --> SS

    %% Integration Layer Relationships
    GH --> ME
    VL --> DC
    PD --> ME

    %% Styling
    classDef content fill:#a8d1f0,stroke:#333,stroke-width:2px
    classDef build fill:#90EE90,stroke:#333,stroke-width:2px
    classDef integration fill:#FFB347,stroke:#333,stroke-width:2px
    classDef output fill:#DDA0DD,stroke:#333,stroke-width:2px

    %% Click Events
    click DC "https://github.com/n8n-io/n8n-docs/tree/main/docs/"
    click SN "https://github.com/n8n-io/n8n-docs/tree/main/_snippets/"
    click DT "https://github.com/n8n-io/n8n-docs/tree/main/document-templates/"
    click GL "https://github.com/n8n-io/n8n-docs/tree/main/_glossary/"
    click MA "https://github.com/n8n-io/n8n-docs/tree/main/docs/_images/"
    click VC "https://github.com/n8n-io/n8n-docs/tree/main/docs/_video/"
    click EW "https://github.com/n8n-io/n8n-docs/tree/main/docs/_workflows/"
    click TO "https://github.com/n8n-io/n8n-docs/tree/main/_overrides/"
    click SC "https://github.com/n8n-io/n8n-docs/tree/main/styles/"
    click BC "https://github.com/n8n-io/n8n-docs/blob/main/mkdocs.yml"
    click GH "https://github.com/n8n-io/n8n-docs/tree/main/.github/workflows/"
    click VL "https://github.com/n8n-io/n8n-docs/blob/main/.vale.ini"
    click PD "https://github.com/n8n-io/n8n-docs/blob/main/requirements.txt"
```
