How habibmrad/n8n-docs works
Project type and purpose
• This is a documentation site repository, built with MkDocs and the Material theme, serving n8n’s docs at docs.n8n.io.
• It contains markdown content (under docs/, _snippets/, _overrides/), styling (styles/), tooling scripts (_doctools/), config files (mkdocs.yml, nav.yml), CI workflows (.github/workflows), and hosting config (netlify.toml, CNAME).
Main components
a. Source code repository (GitHub)
• markdown content
• styles & overrides
• Python build scripts and requirements
• submodules (insiders)
• CI config files
b. Developer environment
• local clone + Python virtualenv
• pip install dependencies & insiders plugin
• mkdocs serve (live preview)
c. CI/CD pipeline (GitHub Actions)
• workflows: lint, build-test, deploy-preview, lexicon checks
• triggers on push, PR, schedule
• artifacts: validated docs, preview site
d. Site builder
• MkDocs (reads mkdocs.yml, nav.yml, docs/*, overrides/*, snippets/*, styles/*)
• Material theme plugin
• custom doctools scripts (_doctools) during build
e. Hosting platform
• Netlify (reads netlify.toml)
• DNS via CNAME to docs.n8n.io
f. End users
• browse static documentation
• assets: images, videos, CSS, JS
Relationships and data flow
• Developer → GitHub (push)
• GitHub Actions → MkDocs build & lint → preview deployment (Netlify Preview)
• On merge to main → CI triggers production build → Netlify publishes to docs.n8n.io
• End user requests docs.n8n.io → served from Netlify CDN → static assets delivered
Architectural patterns and design principles
• Static site generation (SSG) pattern: markdown → MkDocs → HTML/CSS/JS
• Git-driven content management with CI enforcement
• Component separation: content (docs/), design (styles/, _overrides/), tooling (_doctools/)
• Infrastructure-as-Code for CI/CD (.github/workflows) and hosting (netlify.toml)
• Submodule usage to include proprietary or insider features
Technologies, frameworks, and libraries
• Python 3.8+ and pip for build scripts
• MkDocs and Material for MkDocs theme
• GitHub Actions for CI/CD
• Netlify for hosting and preview builds
• _doctools scripts for custom link styling/page info
• Vale linting via .vale.ini for style checks