n8n Docs

This repository hosts the documentation for n8n, an extendable workflow automation tool which enables you to connect anything to everything via its open, fair-code model. The documentation is live at docs.n8n.io.

Previewing and building the documentation locally

Prerequisites

Python 3.8 or above
We recommend using a virtual environment when working with Python, such as venv.

Steps

git clone https://github.com/n8n-io/n8n-docs.git
cd n8n-docs
pip install -r requirements.txt
# You need a GitHub token for access to Material Insiders.
# n8n employees: request this from Deborah
pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
# External contributors: use the free version of Material (most features will still work), or rely on the preview builds on pull requests
pip install mkdocs-material
# Serve a local preview
mkdocs serve
# Or build
mkdocs build

Contributing

Please read our CONTRIBUTING guide.

Support

If you have problems or questions, head to our forum, and we will try to help you as soon as possible: https://community.n8n.io

License

n8n-docs is fair-code licensed under the Sustainable Use License.

Additional information about license can be found in the FAQ.

1.5 KiB Raw Blame History