Custom n8n node: How to define documentation link?

Questions
1

Hello everyone, since a few releases (0.78.0) this usually helpful link shows up when working for a node for more than few moments:
ce_documentation

Is there a way to set a custom URL for this link? Given that my custom node isn’t part of n8n the link currently leads to a 404 page on docs.n8n.io. Thus I am wondering if I can overwrite the URL for this link in my .node.ts file (or anywhere else really). Searching github for documentation reveals plenty of credentials setting documentationUrl but I could not find a way to set a custom documentation URL for nodes. Alternatively, would there be a way to hide this link to prevent users from ending up on that error page?

2

Just implemented that “documentationUrl” on credentials & nodes can be set to full URL (so have to start with “http”).

Will update here once the new version of n8n got released which allows doing that.

2 Likes
3

This is amazing news, thank you so much!

4

Got released with [email protected]

1 Like
5

Is this still valid? I couldn’t find the CredentialsEdit.vue file anymore in the newer release.

6

Hey @liusiyong,

A lot has changed, You can now set the documentaton link using the xx.node.json file.

7

Thanks @Jon

I’ve changed the url for both credentialDocumentation and primaryDocumentation, but the changes don’t seem to have taken effect. Am I missing some steps?