Merge pull request #121 from SpeciesFileGroup/development

Development

README.markdown

@@ -92,7 +92,15 @@ name: 'Charles Darwin'
 # Welcome, {{ name }}!
 ```
 
-To use access TaxonPage internal variables that are provided in `config/*.yml` you can use the script tag in your markdown page and get them from the global object `__APP_ENV__`
+To use TaxonPage internal variables in `config/*.yml`, you can either do so by adding the prefix {{ app:var_name }} or use the script tag in your markdown page and get them from the global object `__APP_ENV__`
+
+#### Prefix
+
+```markdown
+# Welcome to {{ app:project_name }}!
+```
+
+#### Script tag
 
 ```javascript
 # Welcome to {{ project_name }}!

src/plugins/markdown/index.js

@@ -0,0 +1,2 @@
+export * from './relativeToRouter'
+export * from './variableReplacement'

src/plugins/markdown/relativeToRouter.js

@@ -1,4 +1,4 @@
-export default (md) => {
+export function relativeToRouterPlugin(md) {
   const scan = (state) => {
     state.tokens.forEach((tokens) => {
       if (tokens.type !== 'inline') {
@@ -13,7 +13,11 @@ export default (md) => {
         } else if (inlineTokens[i].type === 'link_open') {
           const attrs = inlineTokens[i].attrs
           const href = attrs?.find((v) => v[0] === 'href')
-          if (href && !href[1].startsWith('http')) {
+          if (
+            href &&
+            !href[1].startsWith('http') &&
+            !href[1].startsWith('mailto')
+          ) {
             inlineTokens[i].tag = 'router-link'
             inlineTokens[i].attrs = [['to', href[1]]]
             isRT = true

src/plugins/markdown/variableReplacement.js

@@ -0,0 +1,14 @@
+export function variableReplacementPlugin(md, options) {
+  const regex = /{{\s*app:(.*?)\s*}}/g
+  const variables = options.variables || {}
+
+  md.core.ruler.before('normalize', 'variable_replacement', (state) => {
+    state.src = state.src.replace(regex, (match, content) => {
+      if (Object.hasOwn(variables, content)) {
+        return variables[content]
+      }
+
+      return match
+    })
+  })
+}

vite.config.js

@@ -4,7 +4,10 @@ import path from 'path'
 import Vue from '@vitejs/plugin-vue'
 import Markdown from 'vite-plugin-md'
 import markdownAnchor from 'markdown-it-anchor'
-import markdownRelativeToRouter from './src/plugins/markdown/relativeToRouter.js'
+import {
+  relativeToRouterPlugin,
+  variableReplacementPlugin
+} from './src/plugins/markdown'
 import Pages from 'vite-plugin-pages'
 import './src/utils/globalVars'
 
@@ -31,8 +34,11 @@ export default () => {
           '!container mx-auto p-4 sm:pl-0 sm:pr-0 prose dark:prose-invert box-border',
         markdownItSetup(md) {
           md.use(markdownAnchor)
+          md.use(variableReplacementPlugin, {
+            variables: { ...configuration }
+          })
         },
-        markdownItUses: [markdownRelativeToRouter]
+        markdownItUses: [relativeToRouterPlugin]
       }),
       Pages({
         dirs: 'pages',