noahbohme / n8n-docs

n8n Documentation

n8n Docs

This repository hosts the documentation for n8n, an extendable workflow automation tool which enables you to connect anything to everything. The documentation is live at docs.n8n.io.

Previewing and building the documentation locally

Prerequisites

• Python 3.8 or above
• Pip
• We recommend using a virtual environment when working with Python, such as venv.
• Follow the recommended configuration and auto-complete guidance for the theme. This will help when working with the mkdocs.yml file.

Steps

For members of the n8n GitHub organization:

1. Set up an SSH token and add it to your GitHub account. Refer to GitHub | About SSH for guidance.

2. Then run these commands:

   git clone --recurse-submodules [email protected]:n8n-io/n8n-docs.git
   cd n8n-docs
   pip install -r requirements.txt
   pip install _submodules/insiders

For 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)

git clone https://github.com/n8n-io/n8n-docs.git
cd n8n-docs
pip install -r requirements.txt
pip install mkdocs-material

To serve a local preview:

mkdocs serve

Contributing

Please read our CONTRIBUTING guide.

You can find style guidance in our wiki.

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 License documentation.