Add functionality to link arbitrary strings in code blocks

content/linked-terms.js

@@ -0,0 +1,6 @@
+module.exports = [
+  {
+    matches: 'dvc.yaml',
+    url: '/doc/user-guide/dvc-files-and-directories#dvcyaml-file'
+  }
+]

plugins/gatsby-remark-dvc-linker/index.js

@@ -6,14 +6,15 @@ const visit = require('unist-util-visit')
 
 const apiLinker = require('./apiLinker')
 const commandLinker = require('./commandLinker')
+const simpleLinker = require('./simpleLinker')
 
 // Lifting up the AST visitor in order not to repeat the
 // calculations times the amount of linkers we have
 module.exports = ({ markdownAST }) => {
   visit(
     markdownAST,
     'inlineCode',
-    flow([Array, commandLinker, apiLinker, constant(undefined)])
+    flow([Array, commandLinker, apiLinker, simpleLinker, constant(undefined)])
   )
   return markdownAST
 }

plugins/gatsby-remark-dvc-linker/simpleLinker.js

@@ -0,0 +1,32 @@
+/* eslint-env node */
+
+const { createLinkNode } = require('./helpers')
+
+const entries = require('../../content/linked-terms')
+
+const useMatcher = (matcher, item) => {
+  switch (typeof matcher) {
+    case 'string':
+      return item === matcher
+    case 'object':
+      if (Array.isArray(matcher))
+        return matcher.find(submatcher => useMatcher(submatcher, item))
+      if (matcher instanceof RegExp) return matcher.match(item)
+    default:
+      throw `gatsby-remark-dvc-linker simpleLinker given bad matcher of type "${typeof matcher}"`
+  }
+}
+
+module.exports = astNode => {
+  const node = astNode[0]
+  const parent = astNode[2]
+
+  if (parent.type !== 'link') {
+    const entry = entries.find(({ matches }) => useMatcher(matches, node.value))
+    if (entry) {
+      createLinkNode(entry.url, astNode)
+    }
+  }
+
+  return astNode
+}