Merge pull request #42 from jannis-baum/issue/41-configurable-markdow…

…n-file-extensions

Configurable markdown file-extensions

README.md

@@ -67,6 +67,11 @@ following optional keys:
   evaluation fails, the title will be *custom title error* and you will see the
   error message on the page. The default title are the last two components
   joined with the path separator, e.g.  `you/file.txt`
+- **`"mdExtensions"`**\
+  An array of file extensions that Vivify will parse as Markdown. All other
+  files will be displayed as monospaced text with code highlighting if
+  available. Default Markdown extensions are `['markdown', 'md', 'mdown',
+  'mdwn', 'mkd', 'mkdn']`
 
 ## Usage
 

src/parser/config.ts

@@ -7,6 +7,7 @@ type Config = {
     /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
     katexOptions?: any;
     pageTitle?: string;
+    mdExtensions?: string[];
 };
 let config: Config = {};
 

src/parser/parser.ts

@@ -33,10 +33,10 @@ export const pathHeading = (path: string) => `# \`${path.replace(homedir(), '~')
 export default function parse(src: string, path?: string) {
     let md = src;
 
-    const mdEndings = ['markdown', 'md', 'mdown', 'mdwn', 'mkd', 'mkdn'];
+    const mdExtensions = config.mdExtensions ?? ['markdown', 'md', 'mdown', 'mdwn', 'mkd', 'mkdn'];
 
     const fileEnding = path?.split('.')?.at(-1);
-    if (fileEnding && !mdEndings.includes(fileEnding)) {
+    if (fileEnding && !mdExtensions.includes(fileEnding)) {
         md = `${pathHeading(path!)}\n\n\`\`\`${fileEnding}\n${src}\n\`\`\``;
     }