diff options
author | Marek Łabuz <mareklabuz@Mareks-MacBook-Pro-2.local> | 2019-10-12 15:00:42 +0200 |
---|---|---|
committer | Anna Henningsen <anna@addaleax.net> | 2019-11-30 18:17:56 +0100 |
commit | 62c61b754d7ade2d806fe9017818eb252c54353c (patch) | |
tree | 601323a20172ffa6e4129bfc53a1a2a9d4a754d4 /tools/doc/markdown.js | |
parent | 79faa875026a275b3e5eca019b3c50e1cbe2e34e (diff) | |
download | android-node-v8-62c61b754d7ade2d806fe9017818eb252c54353c.tar.gz android-node-v8-62c61b754d7ade2d806fe9017818eb252c54353c.tar.bz2 android-node-v8-62c61b754d7ade2d806fe9017818eb252c54353c.zip |
tools: add unified plugin changing links for html docs
This commit introduces additional stage in the process of generating
html docs from markdown files. Plugin transforms links to *.md files
in the respository to links to *.html files in the online documentation.
Fixes: https://github.com/nodejs/node/issues/28689
PR-URL: https://github.com/nodejs/node/pull/29946
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Diffstat (limited to 'tools/doc/markdown.js')
-rw-r--r-- | tools/doc/markdown.js | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/tools/doc/markdown.js b/tools/doc/markdown.js new file mode 100644 index 0000000000..97feadbf99 --- /dev/null +++ b/tools/doc/markdown.js @@ -0,0 +1,21 @@ +'use strict'; + +const visit = require('unist-util-visit'); + +module.exports = { + replaceLinks +}; + +function replaceLinks({ filename, linksMapper }) { + return (tree) => { + const fileHtmlUrls = linksMapper[filename]; + + visit(tree, 'definition', (node) => { + const htmlUrl = fileHtmlUrls && fileHtmlUrls[node.identifier]; + + if (htmlUrl && typeof htmlUrl === 'string') { + node.url = htmlUrl; + } + }); + }; +} |