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.
- Python 3.8 or above
- We recommend using a virtual environment when working with Python, such as venv.
git clone https://github.com/n8n-io/n8n-docs.git
cd n8n-docs
pip install -r requirements.txt
# n8n organization members:
# Outside your docs project, do:
git clone https://github.com/n8n-io/mkdocs-material-insiders.git mkdocs-material
# Navigate back into the docs project and run:
pip install -e <path-to-mkdocs-material>
# External contributors: rely on the preview builds on pull requests, or
# use the free version of Material for MkDocs (most things are the same, some formatting may be missing)
pip install mkdocs-material
# Serve a local preview
mkdocs serve
# Or build
mkdocs buildPlease read our CONTRIBUTING guide.
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
n8n-docs is fair-code licensed under the Sustainable Use License.
Additional information about license can be found in the FAQ.