Skip to content

Commit 6f59a22

Browse files
committed
converting TOML links to internal section links
1 parent 3c30f19 commit 6f59a22

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

helper-scripts/influxdb3-plugins/port_to_docs.js

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,20 @@ function expandAbbreviations(content) {
5454
return content;
5555
}
5656

57+
/**
58+
* Convert README TOML links to internal section links.
59+
*/
60+
function convertTomlReadmeLinks(content) {
61+
// If document has TOML configuration section, link to it instead of external README
62+
if (content.includes('## Using TOML Configuration Files')) {
63+
content = content.replace(
64+
/\[([^\]]*TOML[^\]]*)\]\(https:\/\/github\.com\/influxdata\/influxdb3_plugins\/blob\/master\/README\.md\)/gi,
65+
'[$1](#using-toml-configuration-files)'
66+
);
67+
}
68+
return content;
69+
}
70+
5771
/**
5872
* Convert relative links to GitHub URLs.
5973
*/
@@ -251,6 +265,7 @@ function transformContent(content, pluginName, config) {
251265
content = removeDescriptionHeading(content);
252266
content = convertRelativeLinks(content, pluginName);
253267
content = expandAbbreviations(content);
268+
content = convertTomlReadmeLinks(content);
254269
content = addProductShortcodes(content);
255270
content = enhanceOpeningParagraph(content);
256271
content = fixCodeBlockFormatting(content);

0 commit comments

Comments
 (0)