n8n-nodes-sourcey
v0.1.2
Published
n8n community node for retrieving and ingesting Sourcey-generated documentation
Downloads
204
Maintainers
Readme
n8n-nodes-sourcey
Use Sourcey-generated documentation inside n8n workflows.
This community node reads the public artefacts emitted by a Sourcey static docs site:
search-index.jsonfor search candidatesllms-full.txtfor full-page hydrationsitemap.xmlfor ingestion
It does not need credentials for public docs and does not run sourcey build
inside n8n.
Installation
Install n8n-nodes-sourcey from the n8n community nodes panel, or install it
manually in a self-hosted n8n instance.
Operations
Retrieve Context
Returns one item with:
context: packed documentation context ready for an AI Agent promptcitations: source URLs and titlesdocuments: hydrated source documentsconfidence:none,low,medium, orhighstatus:ok,weak_results, orno_results
Use this for Chat Trigger -> Sourcey -> AI Agent -> Respond workflows.
Search
Returns one item per ranked result from search-index.json. Each item includes
title, URL, excerpt, tab, category, score, and metadata.
Use this for branching, result selection, and support routing.
Fetch Page
Fetches one page by path or URL. It prefers llms-full.txt and falls back to
HTML text extraction when the LLM artefact is missing.
Load All
Returns one item per page or chunk for ingestion workflows. Use this with embeddings and vector-store nodes.
Docs Building
Build docs in CI, then use this node against the deployed site.
The recommended workflow is:
- n8n receives a GitHub webhook, schedule, release event, or manual trigger.
- n8n dispatches a GitHub Actions workflow using
sourcey/build-docs. - GitHub Actions builds and deploys the static Sourcey site.
- n8n waits for the deployment URL.
- n8n runs Sourcey Retrieve Context, Search, Fetch Page, or Load All.
This keeps build work in CI and keeps the n8n node fast, dependency-free, and verification-friendly.
Example Workflows
Import the JSON files in workflows/:
ask-docs-chatbot.jsonvector-store-ingestion.jsonsupport-question-router.jsonbuild-and-index-sourcey-docs.json
The workflows avoid Code and Function nodes. If an example needs custom JavaScript glue, the Sourcey node API should be improved instead.
Credentials
None in Phase 1. The node consumes public Sourcey docs sites.
Compatibility
This package is generated from the official n8n-node scaffold and uses the
programmatic node style. It keeps runtime dependencies empty for verified
community-node eligibility.
Development
npm install
npm run typecheck
npm test
npm run buildRun a local n8n instance with the node loaded:
npm run dev