在 Marketplace 上發佈自訂 n8n 整合、文件和工作流程的指南

問題
, , , ,
1

Hi n8n 團隊，

我們目前正在開發一個自訂整合（n8n 節點、產品認證和工作流程），並希望在 n8n Marketplace 上發佈它。

能否請您指導我們以下事項？

  • 在 n8n Marketplace 上發佈自訂節點的流程和標準是什麼？
  • 是否有建立 README 和使用者文件/指南的範本？
  • 文件發佈的步驟是什麼（我們確實找到了 n8n-docs 儲存庫，我們需要在此提交文件嗎）？
  • 在提交節點之前，是否有任何官方文件或檢查清單我們應該遵循？
  • 請也分享工作流程的相應程序。

如果您能分享相關的指南或資源，那將非常有幫助。
謝謝您！

2

嘿 @Avadh_Sonagara，在你等待回應的同時，這裡有一些可能對你有幫助的東西：

建議資源

自動匹配到你的問題。

文檔：

論壇：

@Anshul_Namdev、@Baseman - 你們之前幫助過類似的問題，能看一下嗎？

由 n8n 社群機器人自動建議。這是一個試驗 - 請在此分享反饋。

3

嗨 @Avadh_Sonagara 歡迎！
沒有針對節點的獨立市場上傳。發佈是 npm 加上驗證：套件名稱必須以 n8n-nodes- 或 @scope/n8n-nodes- 開頭，n8n-community-node-package 必須在關鍵字中，你的節點和認證必須在 package.json 中的 n8n 屬性下宣告。一旦發佈到 npm，你就可以在 Login - n8n.io 提交。
n8n 在驗證前檢查的清單：使用 n8n-node CLI 進行腳手架搭建、通過技術驗證指南且完全沒有執行時依賴項、遵循 UX 指南、提交 README，並通過帶有來源聲明的 GitHub Actions 工作流程發佈。自 2026 年 5 月 1 日起，最後一項對 Creator Portal 驗證是強制性的，從本機發佈的套件不被接受。
文件不進入 n8n-docs 儲存庫。要求是 npm 套件或連結的公開儲存庫中的 README，因此 README 是你的使用者指南。n8n-docs 儲存庫確實包含頁面範本，你可以複製其結構，app-nodes.md、credentials.md 和 common-issues.md 位於其 document-templates/ 資料夾中：
Contribution guide for n8n Docs | Contribute | n8n Docs
工作流程通過相同的 Creator hub 帳戶而不是儲存庫進行：

4

嗨 @Anshul_Namdev，感謝你的詳細說明！

我對文檔部分有一個小疑問。能否請你確認我是否理解正確？

  • 對於我們的自訂節點，所有面向用戶的文檔（類似於 app-nodes.md、credentials.md、common-issues.md 範本等）是否應該包含在我們套件的 README.md 中 / 連結到公開倉庫？
  • 我們不需要向 n8n-docs 倉庫建立 PR 或提交文檔，對吧？
  • 節點通過 Creator Portal 提交驗證後，n8n 團隊是否負責在 n8n 一側的文檔發佈/整合，還是我們需要完成任何單獨的文檔提交步驟？

我已經熟悉節點/套件發佈流程了。我唯一的困惑是關於文檔發佈流程，以及我們是否需要單獨對 n8n-docs 做任何事情。

再次感謝你幫助釐清這一點！

5

是的，前兩項都同意。
npm 套件中的 README 或連結的公開儲存庫是面向使用者的文件，驗證指南規定它必須包含：使用說明、範例工作流程和驗證詳細資訊，僅限英文。app-nodes.md 和 credentials.md 範本只是你可以複製到其中的結構。
不需要向 n8n-docs 提交 PR。那裡的新頁面必須先作為問題提出，以便文件團隊確認範圍，文件中的社群節點部分涵蓋安裝和使用社群節點的一般內容，而不是為每個節點保留參考頁面。
提交後也沒有單獨的文件步驟。驗證會從 npm 取得套件，使用者在節點面板中看到的詳細資訊是從該套件中的節點定義構建的，所以在 npm 上保持 README 最新就是全部工作。

6

嗨 @Anshul_Namdev @OliverScheiber，再次感謝你們的確認。

關於文檔，我只需要最後澄清一下：

據我所知，我們只需要在 README.md 中維護文檔（無論是在 npm 套件中還是連結到的公開儲存庫），並按照 app-nodes.md、credentials.md 和 common-issues.md 範本的結構進行。這樣理解對嗎？

另外，所有這些部分（app-nodes、credentials、common-issues 等）應該一起包含在單個 README.md 中，還是應該為每個部分創建單獨的文檔文件？

而且，節點通過 Creator Portal 提交後，n8n 將使用我們提供的文檔/套件信息，我們無需進行單獨的文檔提交，對嗎？

另外，你們的團隊會根據我的 README 發布文檔，對吧？

感謝確認！

7

@Avadh_Sonagara 這個討論串裡有很多你在找的答案！

不過，沒錯，一切都應該放在 README 中，沒錯，我相信他們會使用你提供的文件！

8

將其作為單一 README.md 保存在套件根目錄中。這是 npm 在套件頁面上顯示的文件，也是審核者閱讀的文件，因此任何拆分為單獨文件的內容只有在 README 連結到它時才會被看到。使用 app-node、credential 和 common-issues 範本作為該單一 README 內的章節標題，而不是作為獨立文件。n8n 不會託管或重新發佈您的文件：節點面板中出現的「文件」連結來自每個節點的 *.node.json 代碼集文件中的 resources.primaryDocumentation.url，因此請將其指向您的儲存庫頁面或您自己的文件 URL。發佈後，在工作流程中開啟節點並點擊該連結以確認它會解析而不是返回 404。

9

我從工作流程範本的角度補充一點：將文檔視為工作流程的一部分，而不是在建置完成後才補上的東西。

對於可供提交的工作流程，我希望有人能夠理解：

- 工作流程做什麼

- 需要什麼憑證

- 它期望什麼輸入

- 他們應該看到什麼輸出

- 它可能在哪裡失敗

- 如何安全地測試它

畫布內的便箋非常有幫助，因為有人可以打開工作流程並按照路徑進行，而無需先閱讀另外的指南。我仍然會保持 README 簡潔，但工作流程本身應該解釋重要的決策和交接。