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 locallymkdocs.yml
file..editorconfig
file. Make sure your local editor settings do not override these settings. In particular:
Set up an SSH token and add it to your GitHub account. Refer to GitHub | About SSH for guidance.
Then run these commands:
git clone --recurse-submodules git@github.com:n8n-io/n8n-docs.git cd n8n-docs # Set up virtual environment if using one (steps depend on your system) # Install dependencies pip install -r requirements.txt pip install _submodules/insiders
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)
Fork the repository, then:
git clone https://github.com/<your-username>/n8n-docs.git
cd n8n-docs
pip install -r requirements.txt
pip install mkdocs-material
To serve a local preview:
Please read the CONTRIBUTING guide.
You can find style guidance in the wiki.
If you have problems or questions, head to n8n's forum: https://community.n8n.io
n8n-docs is fair-code licensed under the Sustainable Use License.
More information about the license is available in the License documentation.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4