From 7e853e2462599907f080b7921329416b6ffe0b7f Mon Sep 17 00:00:00 2001 From: Jan Oberhauser Date: Sat, 23 May 2020 18:13:47 +0200 Subject: [PATCH] :tada: Initial commit --- .editorconfig | 15 ++ .gitignore | 11 + LICENSE.md | 230 ++++++++++++++++++ README.md | 23 ++ docs/.vuepress/config.js | 67 +++++ docs/.vuepress/public/assets/img/n8n-logo.png | Bin 0 -> 2675 bytes docs/.vuepress/theme-test/Layout.vue | 6 + docs/README.md | 9 + docs/credentials/ActiveCampaign/README.md | 3 + docs/credentials/Affinity/README.md | 3 + docs/credentials/README.md | 3 + docs/nodes/ActiveCampaign/README.md | 3 + docs/nodes/README.md | 3 + package.json | 25 ++ 14 files changed, 401 insertions(+) create mode 100644 .editorconfig create mode 100644 .gitignore create mode 100644 LICENSE.md create mode 100644 README.md create mode 100644 docs/.vuepress/config.js create mode 100644 docs/.vuepress/public/assets/img/n8n-logo.png create mode 100644 docs/.vuepress/theme-test/Layout.vue create mode 100644 docs/README.md create mode 100644 docs/credentials/ActiveCampaign/README.md create mode 100644 docs/credentials/Affinity/README.md create mode 100644 docs/credentials/README.md create mode 100644 docs/nodes/ActiveCampaign/README.md create mode 100644 docs/nodes/README.md create mode 100644 package.json diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 000000000..9e24325d4 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,15 @@ +root = true + +[*] +charset = utf-8 +indent_style = tab +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true + +[package.json] +indent_style = space +indent_size = 2 + +[*.ts] +quote_type = single diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..664c9c9da --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +node_modules +.DS_Store +.tmp +tmp +dist +npm-debug.log* +package-lock.json +yarn.lock +.env +.vscode +.idea diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 000000000..aac54547e --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,230 @@ +“Commons Clause” License Condition v1.0 + +The Software is provided to you by the Licensor under the +License, as defined below, subject to the following condition. + +Without limiting other conditions in the License, the grant +of rights under the License will not include, and the License +does not grant to you, the right to Sell the Software. + +For purposes of the foregoing, “Sell” means practicing any or +all of the rights granted to you under the License to provide +to third parties, for a fee or other consideration (including +without limitation fees for hosting or consulting/ support +services related to the Software), a product or service whose +value derives, entirely or substantially, from the functionality +of the Software. Any license notice or attribution required by +the License must also include this Commons Clause License +Condition notice. + +Software: n8n + +License: Apache 2.0 + +Licensor: n8n GmbH + + +--------------------------------------------------------------------- + + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 000000000..e4b54699e --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# n8n Documentation + +Repository with the official n8n documentation. + + +## Build Documentation + +To build the documentation: + +```bash +npm install +npm run build +``` + + +## Development + +To extend the documentation: + +```bash +npm install +npm run dev +``` diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js new file mode 100644 index 000000000..6da8a1a9e --- /dev/null +++ b/docs/.vuepress/config.js @@ -0,0 +1,67 @@ +const dirTree = require('directory-tree'); +const path = require('path'); + +function getChildren(folder) { + return dirTree(path.join(__dirname, `../${folder}`), { extensions: /\.md/ }).children + .filter(page => { + return page.type === 'directory' && !!page.children.find(child => child.name === 'README.md'); + }) + .map(page => { + return `/${folder}/${page.name}/`; + }); +} + +module.exports = { + description: 'Documentation for n8n', + title: 'n8n Documentation', + plugins: [ + 'vuepress-plugin-reading-time', + '@vuepress/last-updated', + [ + 'vuepress-plugin-code-copy', + true, + ], + // [ + // '@vuepress/google-analytics', + // { + // 'ga': '', // UA-00000000-0 + // }, + // ], + ], + themeConfig: { + repo: 'n8n-io/n8n', + docsRepo: 'n8n-io/n8n-docs', + docsDir: 'docs', + editLinks: true, + editLinkText: 'Help us improve this page!', + smoothScroll: true, + lastUpdated: true, + searchPlaceholder: 'Search...', + logo: '/assets/img/n8n-logo.png', + nav: [ + { + text: 'Home', + link: '/', + }, + { + text: 'Community', + link: 'https://community.n8n.io', + }, + ], + sidebar: [ + ['/', 'Home'], + { + title: 'Credentials', + path: '/credentials/', + sidebarDepth: 2, + children: getChildren('credentials'), + }, + { + title: 'Nodes', + path: '/nodes/', + sidebarDepth: 2, + children: getChildren('nodes'), + }, + ], + }, +} diff --git a/docs/.vuepress/public/assets/img/n8n-logo.png b/docs/.vuepress/public/assets/img/n8n-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..a77f36aeeead7e17aa4390937e90f48652d811c8 GIT binary patch literal 2675 zcmV-(3XJuMP)Px#Do{*RMF0Q*I89ssZCd|rS~yKx|7}|TZCW@@TdQ7L z|7}`0O000bhQchC013}YL_t(| z+U=d$nyVlTfXlwvzW?h^_X3gxP^@;y)%i}xYWc}R67Y07peQATQ0g?~2gC_}ehC)? z>cK^QXug=*F)F`<^Nw_A=|RQnb6)gN(nC5=eujj*F+9J-a}fPCo`dM|{3p(H5Ivgc zGbMTq(t$*rX%Sm_q39=yeTRx3MHC#(M#gyL z01p`AI%Iu10^NP23~t3uR5<1*Lq9qO^ZV9R^K*q{++=8Uht2&q&MKOKQ57T3Ju1$; z3aSBgkBiGP$t7&v0J;aUx`Agt>gfm68p+t@DvZg=Z!s!LUqu|S&|vv_??CNzXZaB( zdoz7Iq2rmFHlADhPy#Gt$bc~TWd-)F!=cp?UFLmkIDL& zr>peSSiu|j>ZQuUkx)lBL@@;mowYix-xilym~|JM>(*|k5t&irC1akggMnMZbW0SY znzDk6)+`h9S)Y|lKvb+eKWb(^R5yY4ZStmdqi9G9E_0zdv)VV#eFu4KYo-ulL_>{a-Kwass{6g}ZrVZ))y6Z&Y(e?b<;`v;q7ITh zpYb$FNi09o6PDnc1I=Y2Y*I^QB|&jmNJnYTQp=_u3m6&k`U>Wv@?}Ozv+5cB>IXN= z%F^r}3w-7mW@@FG(m1mfK#?HYWXrU(2~$wb(oLafZYnG+U&f8RTq`mi`xqWmTsT1% zn`W-P(bqu}r-bNbJ_l!W4XV0dn8&c_q+1;v{8Y2~?aDNTqv1Kwm<&-uKLid3WjfAN zc`0myQ?_g#Fr{S}4-L7k0V+{vKy*^XSs4CG__>%VCsz`0SC-gC1qze@<3*(~js(h{GcB5&2qn9NQ3**G< zGW;Tj`Ona7L}9O-RkK{SMi<6Pp`g}Nhi+M9!mR%1&={nt)}yt})N-=P1QF&$On@ln z48E$Ma|KFVc({?&qyYh5%_`e~!W(iG{kz%>64_I=O+)lb}GL5y)x3$3e8I&5+9mqC|- z6Phl9d0GOfsY*SS0cH4VHkf^u%#{~yTByzsZ*q{EL1S58lv^lUe6S*e+zga#eet2W zC%l?ybD=oUZ4Tx$cqj{hR+^H@xj5|8R-lYD+A_HRzW{0xpx6>Ynt3{0BE3dg+;SmM zi~fw{PyD|yxw0mrG)Y7`-zRE8pzPEEXh|oN{LHBT5ES_epf&@}%S&0rEPDWz1q<0A z^7;qM7FH8c$}G0HW(_VAeGi~TKKS!!8nwA)J99I=Lwiar$O@pKT1QByny_arpseJ| zOEmHd!*V;)G!l$XSXRlW{?2ZfK#}rxxHz>H3zMZli`KE9n>a+%qH34Lv{w~;wqbHU z25QO&56uDuN;-W3s4N2-*T^i$6K(fOgB;*HH!Ght1D(pW8c^$f098<(T2TdV4){cP zm)}+e?q;Bj=<3PaT!s$$#wIt7M_+AM$^Iiwu1xrICt=dN68p-HT2Ph)rD6}WW1wob zRqrY#O=7b>VLWr8fF}WEbKR>QOenVzP-^hd<3H!Ry3t;oXOrs zUVmO%51{4?KxIK!l8qjm-hByeKc%OFLhQ6C##ws2#!mvB3U;L?mV?R%fr&bDDhN!g zVW5Jqkc?OY^s*z9TT)O>eY%NA6q)@5MdU+;(RWd?3-fg- z(JV0%DE5^#L|cGLTpN5oG1wWXBvmw19e_715o3rPe4C#L6i|HYR0YvRiG}<{L}H;6 zP*3%lWuF=XL%%*3aCr2NHQwTu%ZauCwP;a%0!Fqo(38YZNP>D&RR*apI_XQ-oVGz6 znxR`G?p1&WV~6yWr7MWuKt0+4cIxSuzm(~rbN9ZGI9(GxcxvuIxo$ndrU_`gvE_4R+=$|vfO_)r zz$`z5I>y7A9{bMA-_WDsk_7T2Jv7t*Re@fZyh_fC-anh}n@$+oJYNX(ej{H3GN8PKcP3jUrC87kBJySe@w7fHd8*-j^R5P zQnx(H9r6vNniuajJn;Kc|CKoPKATLVohE#|J^gTOv9L&-M@)1$(J)bU9v1h2E*0!I z6r1i99*)Xh literal 0 HcmV?d00001 diff --git a/docs/.vuepress/theme-test/Layout.vue b/docs/.vuepress/theme-test/Layout.vue new file mode 100644 index 000000000..defd2b3df --- /dev/null +++ b/docs/.vuepress/theme-test/Layout.vue @@ -0,0 +1,6 @@ + diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..4e162a416 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,9 @@ +# n8n Documentation + +Some more text. + + +Here is some code: +```javascript +console.log('test'); +``` diff --git a/docs/credentials/ActiveCampaign/README.md b/docs/credentials/ActiveCampaign/README.md new file mode 100644 index 000000000..52ddff514 --- /dev/null +++ b/docs/credentials/ActiveCampaign/README.md @@ -0,0 +1,3 @@ +# Active Campaign + +How to create Active Campaign credentials. diff --git a/docs/credentials/Affinity/README.md b/docs/credentials/Affinity/README.md new file mode 100644 index 000000000..721c3ede7 --- /dev/null +++ b/docs/credentials/Affinity/README.md @@ -0,0 +1,3 @@ +# Affinity + +How to create Affinity credentials. diff --git a/docs/credentials/README.md b/docs/credentials/README.md new file mode 100644 index 000000000..17f20b36d --- /dev/null +++ b/docs/credentials/README.md @@ -0,0 +1,3 @@ +# Credentials + +Information about different credentials in n8n. diff --git a/docs/nodes/ActiveCampaign/README.md b/docs/nodes/ActiveCampaign/README.md new file mode 100644 index 000000000..f8d5e2169 --- /dev/null +++ b/docs/nodes/ActiveCampaign/README.md @@ -0,0 +1,3 @@ +# Active Campaign + +Information about Active Campaign node. diff --git a/docs/nodes/README.md b/docs/nodes/README.md new file mode 100644 index 000000000..3362d02fd --- /dev/null +++ b/docs/nodes/README.md @@ -0,0 +1,3 @@ +# Nodes + +Information about different nodes in n8n. diff --git a/package.json b/package.json new file mode 100644 index 000000000..24bae29c3 --- /dev/null +++ b/package.json @@ -0,0 +1,25 @@ +{ + "name": "n8n-docs", + "version": "0.0.1", + "description": "n8n Documentation", + "license": "SEE LICENSE IN LICENSE.md", + "homepage": "https://n8n.io", + "repository": { + "type": "git", + "url": "git+https://github.com/n8n-io/n8n-docs.git" + }, + "main": "index.js", + "scripts": { + "dev": "vuepress dev docs", + "build": "vuepress build docs" + }, + "author": "", + "dependencies": {}, + "devDependencies": { + "@vuepress/plugin-google-analytics": "^1.5.0", + "directory-tree": "^2.2.4", + "vuepress": "^1.5.0", + "vuepress-plugin-code-copy": "^1.0.6", + "vuepress-plugin-reading-time": "^0.1.1" + } +}