Giter Site home page Giter Site logo

n8n-docs's Introduction

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
# 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 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.

n8n-docs's People

Contributors

ahsanv avatar dependabot[bot] avatar erin2722 avatar gpene avatar harshil1712 avatar inputsh avatar ivov avatar janober avatar kinduff avatar krynble avatar kylefmohr avatar lorenanda avatar m2scared avatar maxtkacz avatar medalimarz avatar mutdmour avatar pedrohdq avatar phizab avatar preya avatar ricardoe105 avatar rupenieks avatar shraddha2104 avatar simonmayerhofer avatar smamudhan avatar starfallprojects avatar tanay1337 avatar tephlondude avatar that-one-tom avatar vcrwr avatar vuchl avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.