@goldstack/utils-docs 0.4.0 → 0.4.1

package/dist/src/githubConstants.d.ts

@@ -1,5 +1,5 @@
-export declare const GITHUB_URL = "https://github.com";
-export declare const GITHUB_API_URL = "https://api.github.com";
-export declare const RAW_GITHUB_URL = "https://raw.githubusercontent.com";
-export declare const REPO_NAME = "goldstack/goldstack";
+export declare const GITHUB_URL = "https://github.com";
+export declare const GITHUB_API_URL = "https://api.github.com";
+export declare const RAW_GITHUB_URL = "https://raw.githubusercontent.com";
+export declare const REPO_NAME = "goldstack/goldstack";
 //# sourceMappingURL=githubConstants.d.ts.map

package/dist/src/githubConstants.js

@@ -1,8 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.REPO_NAME = exports.RAW_GITHUB_URL = exports.GITHUB_API_URL = exports.GITHUB_URL = void 0;
-exports.GITHUB_URL = 'https://github.com';
-exports.GITHUB_API_URL = 'https://api.github.com';
-exports.RAW_GITHUB_URL = 'https://raw.githubusercontent.com';
-exports.REPO_NAME = 'goldstack/goldstack';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.REPO_NAME = exports.RAW_GITHUB_URL = exports.GITHUB_API_URL = exports.GITHUB_URL = void 0;
+exports.GITHUB_URL = 'https://github.com';
+exports.GITHUB_API_URL = 'https://api.github.com';
+exports.RAW_GITHUB_URL = 'https://raw.githubusercontent.com';
+exports.REPO_NAME = 'goldstack/goldstack';
 //# sourceMappingURL=githubConstants.js.map

package/dist/src/markdownToHtml.d.ts

@@ -1,2 +1,2 @@
-export declare function markdownToHtml(filePath: any, tag: any, md: any): Promise<string>;
+export declare function markdownToHtml(filePath: any, tag: any, md: any): Promise<string>;
 //# sourceMappingURL=markdownToHtml.d.ts.map

package/dist/src/markdownToHtml.js

@@ -1,64 +1,64 @@
-"use strict";
-// based on https://github.com/vercel/next-site/blob/e2cb07a057bf75bded2571a1b639b0017572f4b8/lib/docs/markdown-to-html.js
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.markdownToHtml = void 0;
-const unified_1 = __importDefault(require("unified"));
-const remark_parse_1 = __importDefault(require("remark-parse"));
-const remark_rehype_1 = __importDefault(require("remark-rehype"));
-const rehype_raw_1 = __importDefault(require("rehype-raw"));
-const rehype_prism_1 = __importDefault(require("@mapbox/rehype-prism"));
-const rehype_stringify_1 = __importDefault(require("rehype-stringify"));
-// https://github.com/syntax-tree/hast-util-sanitize/blob/master/lib/github.json
-const github_json_1 = __importDefault(require("hast-util-sanitize/lib/github.json"));
-const rehypeDocs_1 = __importDefault(require("./rehypeDocs"));
-const rehypeMarkdownToHtml_1 = __importDefault(require("./rehypeMarkdownToHtml"));
-// Allow className for all elements
-github_json_1.default.attributes['*'].push('className');
-const handlers = {
-    // Add a className to inlineCode so we can differentiate between it and code fragments
-    inlineCode(h, node) {
-        return {
-            ...node,
-            type: 'element',
-            tagName: 'code',
-            properties: { className: 'inline' },
-            children: [
-                {
-                    type: 'text',
-                    value: node.value,
-                },
-            ],
-        };
-    },
-};
-async function markdownToHtml(filePath, tag, md) {
-    try {
-        // Init the processor with our custom plugin
-        let processor = undefined;
-        processor = (0, unified_1.default)()
-            .use(remark_parse_1.default)
-            .use(rehypeMarkdownToHtml_1.default, { filePath, tag, processor: () => processor })
-            .use(remark_rehype_1.default, { handlers, allowDangerousHTML: true })
-            // Add custom HTML found in the markdown file to the AST
-            .use(rehype_raw_1.default)
-            // Sanitize the HTML
-            // .use(sanitize, githubSchema)
-            // Add syntax highlighting to the sanitized HTML
-            .use(rehype_prism_1.default)
-            .use(rehype_stringify_1.default)
-            .freeze()()
-            .use(rehypeDocs_1.default, { filePath, tag, processor });
-        const file = await processor.process(md);
-        // Replace non-breaking spaces (char code 160) with normal spaces to avoid style issues
-        return file.contents.replace(/\xA0/g, ' ');
-    }
-    catch (error) {
-        console.error(`Markdown to HTML error: ${error}`);
-        throw error;
-    }
-}
-exports.markdownToHtml = markdownToHtml;
+"use strict";
+// based on https://github.com/vercel/next-site/blob/e2cb07a057bf75bded2571a1b639b0017572f4b8/lib/docs/markdown-to-html.js
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.markdownToHtml = void 0;
+const unified_1 = __importDefault(require("unified"));
+const remark_parse_1 = __importDefault(require("remark-parse"));
+const remark_rehype_1 = __importDefault(require("remark-rehype"));
+const rehype_raw_1 = __importDefault(require("rehype-raw"));
+const rehype_prism_1 = __importDefault(require("@mapbox/rehype-prism"));
+const rehype_stringify_1 = __importDefault(require("rehype-stringify"));
+// https://github.com/syntax-tree/hast-util-sanitize/blob/master/lib/github.json
+const github_json_1 = __importDefault(require("hast-util-sanitize/lib/github.json"));
+const rehypeDocs_1 = __importDefault(require("./rehypeDocs"));
+const rehypeMarkdownToHtml_1 = __importDefault(require("./rehypeMarkdownToHtml"));
+// Allow className for all elements
+github_json_1.default.attributes['*'].push('className');
+const handlers = {
+    // Add a className to inlineCode so we can differentiate between it and code fragments
+    inlineCode(h, node) {
+        return {
+            ...node,
+            type: 'element',
+            tagName: 'code',
+            properties: { className: 'inline' },
+            children: [
+                {
+                    type: 'text',
+                    value: node.value,
+                },
+            ],
+        };
+    },
+};
+async function markdownToHtml(filePath, tag, md) {
+    try {
+        // Init the processor with our custom plugin
+        let processor = undefined;
+        processor = (0, unified_1.default)()
+            .use(remark_parse_1.default)
+            .use(rehypeMarkdownToHtml_1.default, { filePath, tag, processor: () => processor })
+            .use(remark_rehype_1.default, { handlers, allowDangerousHTML: true })
+            // Add custom HTML found in the markdown file to the AST
+            .use(rehype_raw_1.default)
+            // Sanitize the HTML
+            // .use(sanitize, githubSchema)
+            // Add syntax highlighting to the sanitized HTML
+            .use(rehype_prism_1.default)
+            .use(rehype_stringify_1.default)
+            .freeze()()
+            .use(rehypeDocs_1.default, { filePath, tag, processor });
+        const file = await processor.process(md);
+        // Replace non-breaking spaces (char code 160) with normal spaces to avoid style issues
+        return file.contents.replace(/\xA0/g, ' ');
+    }
+    catch (error) {
+        console.error(`Markdown to HTML error: ${error}`);
+        throw error;
+    }
+}
+exports.markdownToHtml = markdownToHtml;
 //# sourceMappingURL=markdownToHtml.js.map

package/dist/src/permalinkIconAst.d.ts

@@ -1,3 +1,3 @@
-declare const permalinkIcon: import("unist").Node;
-export default permalinkIcon;
+declare const permalinkIcon: import("unist").Node;
+export default permalinkIcon;
 //# sourceMappingURL=permalinkIconAst.d.ts.map

package/dist/src/permalinkIconAst.js

@@ -1,10 +1,10 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const unified_1 = __importDefault(require("unified"));
-const rehype_raw_1 = __importDefault(require("rehype-raw"));
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const unified_1 = __importDefault(require("unified"));
+const rehype_raw_1 = __importDefault(require("rehype-raw"));
 const ICON_HTML = `<svg viewBox="0 0 16 16" width="16" height="16">
   <g strokeWidth="1" fill="#000000" stroke="#000000">
     <path
@@ -23,10 +23,10 @@ const ICON_HTML = `<svg viewBox="0 0 16 16" width="16" height="16">
       d="M7.005,8.995 L7.005,8.995c-1.374-1.374-1.374-3.601,0-4.975l1.99-1.99c1.374-1.374,3.601-1.374,4.975,0l0,0c1.374,1.374,1.374,3.601,0,4.975 l-1.748,1.698"
     />
   </g>
-</svg>`;
-const permalinkIcon = (0, unified_1.default)().use(rehype_raw_1.default).runSync({
-    type: 'raw',
-    value: ICON_HTML,
-});
-exports.default = permalinkIcon;
+</svg>`;
+const permalinkIcon = (0, unified_1.default)().use(rehype_raw_1.default).runSync({
+    type: 'raw',
+    value: ICON_HTML,
+});
+exports.default = permalinkIcon;
 //# sourceMappingURL=permalinkIconAst.js.map

package/dist/src/rehypeDocs.d.ts

@@ -1,6 +1,6 @@
-export default function rehypeDocs({ filePath, tag, processor }: {
-    filePath: any;
-    tag: any;
-    processor: any;
-}): (tree: any) => void;
+export default function rehypeDocs({ filePath, tag, processor }: {
+    filePath: any;
+    tag: any;
+    processor: any;
+}): (tree: any) => void;
 //# sourceMappingURL=rehypeDocs.d.ts.map

package/dist/src/rehypeDocs.js

@@ -1,76 +1,76 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const unist_util_visit_1 = __importDefault(require("unist-util-visit"));
-const mdast_util_to_string_1 = __importDefault(require("mdast-util-to-string"));
-const github_slugger_1 = __importDefault(require("github-slugger"));
-const permalinkIconAst_1 = __importDefault(require("./permalinkIconAst"));
-const ABSOLUTE_URL = /^(https?:\/\/|\/\/)/i;
-// The headers will be updated to include a link to their hash
-const HEADINGS = ['h2', 'h3', 'h4', 'h5', 'h6'];
-function rehypeDocs({ filePath, tag, processor }) {
-    const slugger = new github_slugger_1.default();
-    const anchorSlugger = new github_slugger_1.default();
-    function visitAnchor(node) {
-        const props = node.properties;
-        const href = props === null || props === void 0 ? void 0 : props.href;
-        if (!href)
-            return;
-        if (props.href === href) {
-            const isAbsoluteUrl = ABSOLUTE_URL.test(href);
-            // const isHash = href[0] === '#';
-            // const isRepoUrl = !isHash;
-            if (isAbsoluteUrl) {
-                props.className = 'absolute';
-                props.target = '_blank';
-                props.rel = 'noopener noreferrer';
-                return;
-            }
-        }
-        const [relativePath, hash] = props.href.split('#');
-        // Reset the slugger because single pages can have multiple urls to the same hash
-        anchorSlugger.reset();
-        // The URL is relative at this point
-        props.className = 'relative';
-        // Update the hash used by anchors to match the one set for headers
-        props.href = hash
-            ? `${relativePath}#${anchorSlugger.slug(hash)}`
-            : relativePath;
-    }
-    function visitHeading(node) {
-        const text = (0, mdast_util_to_string_1.default)(node);
-        if (!text)
-            return;
-        const id = slugger.slug(text);
-        node.properties.className = 'heading';
-        node.children = [
-            {
-                type: 'element',
-                tagName: 'span',
-                properties: { id },
-            },
-            {
-                type: 'element',
-                tagName: 'a',
-                properties: {
-                    href: `#${id}`,
-                },
-                children: node.children,
-            },
-            {
-                type: 'element',
-                tagName: 'span',
-                properties: { className: 'permalink' },
-                children: [permalinkIconAst_1.default],
-            },
-        ];
-    }
-    return function transformer(tree) {
-        (0, unist_util_visit_1.default)(tree, (node) => node.tagName === 'a', visitAnchor);
-        (0, unist_util_visit_1.default)(tree, (node) => HEADINGS.includes(node.tagName), visitHeading);
-    };
-}
-exports.default = rehypeDocs;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const unist_util_visit_1 = __importDefault(require("unist-util-visit"));
+const mdast_util_to_string_1 = __importDefault(require("mdast-util-to-string"));
+const github_slugger_1 = __importDefault(require("github-slugger"));
+const permalinkIconAst_1 = __importDefault(require("./permalinkIconAst"));
+const ABSOLUTE_URL = /^(https?:\/\/|\/\/)/i;
+// The headers will be updated to include a link to their hash
+const HEADINGS = ['h2', 'h3', 'h4', 'h5', 'h6'];
+function rehypeDocs({ filePath, tag, processor }) {
+    const slugger = new github_slugger_1.default();
+    const anchorSlugger = new github_slugger_1.default();
+    function visitAnchor(node) {
+        const props = node.properties;
+        const href = props === null || props === void 0 ? void 0 : props.href;
+        if (!href)
+            return;
+        if (props.href === href) {
+            const isAbsoluteUrl = ABSOLUTE_URL.test(href);
+            // const isHash = href[0] === '#';
+            // const isRepoUrl = !isHash;
+            if (isAbsoluteUrl) {
+                props.className = 'absolute';
+                props.target = '_blank';
+                props.rel = 'noopener noreferrer';
+                return;
+            }
+        }
+        const [relativePath, hash] = props.href.split('#');
+        // Reset the slugger because single pages can have multiple urls to the same hash
+        anchorSlugger.reset();
+        // The URL is relative at this point
+        props.className = 'relative';
+        // Update the hash used by anchors to match the one set for headers
+        props.href = hash
+            ? `${relativePath}#${anchorSlugger.slug(hash)}`
+            : relativePath;
+    }
+    function visitHeading(node) {
+        const text = (0, mdast_util_to_string_1.default)(node);
+        if (!text)
+            return;
+        const id = slugger.slug(text);
+        node.properties.className = 'heading';
+        node.children = [
+            {
+                type: 'element',
+                tagName: 'span',
+                properties: { id },
+            },
+            {
+                type: 'element',
+                tagName: 'a',
+                properties: {
+                    href: `#${id}`,
+                },
+                children: node.children,
+            },
+            {
+                type: 'element',
+                tagName: 'span',
+                properties: { className: 'permalink' },
+                children: [permalinkIconAst_1.default],
+            },
+        ];
+    }
+    return function transformer(tree) {
+        (0, unist_util_visit_1.default)(tree, (node) => node.tagName === 'a', visitAnchor);
+        (0, unist_util_visit_1.default)(tree, (node) => HEADINGS.includes(node.tagName), visitHeading);
+    };
+}
+exports.default = rehypeDocs;
 //# sourceMappingURL=rehypeDocs.js.map

package/dist/src/rehypeMarkdownToHtml.d.ts

@@ -1,6 +1,6 @@
-export default function rehypeDocs({ filePath, tag, processor }: {
-    filePath: any;
-    tag: any;
-    processor: any;
-}): any;
+export default function rehypeDocs({ filePath, tag, processor }: {
+    filePath: any;
+    tag: any;
+    processor: any;
+}): any;
 //# sourceMappingURL=rehypeMarkdownToHtml.d.ts.map

package/dist/src/rehypeMarkdownToHtml.js

@@ -1,50 +1,50 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-const path_1 = require("path");
-const unist_util_visit_1 = __importDefault(require("unist-util-visit"));
-const path_2 = __importDefault(require("path"));
-function rehypeDocs({ filePath, tag, processor }) {
-    function visitInlineCode(node) {
-        const value = node.value;
-        if (value.startsWith('markdown:')) {
-            const file = value.substr(9);
-            const combinedPath = path_2.default.normalize((0, path_1.dirname)(filePath) + '/' + file);
-            if (!fs_1.default.existsSync(combinedPath)) {
-                throw Error(`Invalid fragment specified; no such file "${combinedPath}"`);
-            }
-            const code = fs_1.default.readFileSync(combinedPath, 'utf8');
-            const markdown = processor();
-            try {
-                node.value = `<div class=\"markdown-fragment\">${markdown.processSync(code)}</div>`;
-                node.type = 'html';
-            }
-            catch (e) {
-                throw Error(`${e.message} \nFile: ${file}`);
-            }
-        }
-    }
-    function visitLink(node) {
-        if (node.children.length > 0 && node.children[0].value === '!embed') {
-            const file = node.url;
-            const combinedPath = path_2.default.normalize((0, path_1.dirname)(filePath) + '/' + file);
-            if (!fs_1.default.existsSync(combinedPath)) {
-                throw Error(`Invalid fragment specified; no such file "${combinedPath}"`);
-            }
-            const code = fs_1.default.readFileSync(combinedPath, 'utf8');
-            const markdown = processor();
-            try {
-                node.value = `<div class=\"markdown-fragment\">${markdown.processSync(code)}</div>`;
-                node.type = 'html';
-            }
-            catch (e) {
-                throw Error(`${e.message} \nFile: ${file}`);
-            }
-        }
-        if (node.children.length > 0 && node.children[0].value.indexOf('%') === 0) {
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const path_1 = require("path");
+const unist_util_visit_1 = __importDefault(require("unist-util-visit"));
+const path_2 = __importDefault(require("path"));
+function rehypeDocs({ filePath, tag, processor }) {
+    function visitInlineCode(node) {
+        const value = node.value;
+        if (value.startsWith('markdown:')) {
+            const file = value.substr(9);
+            const combinedPath = path_2.default.normalize((0, path_1.dirname)(filePath) + '/' + file);
+            if (!fs_1.default.existsSync(combinedPath)) {
+                throw Error(`Invalid fragment specified; no such file "${combinedPath}"`);
+            }
+            const code = fs_1.default.readFileSync(combinedPath, 'utf8');
+            const markdown = processor();
+            try {
+                node.value = `<div class=\"markdown-fragment\">${markdown.processSync(code)}</div>`;
+                node.type = 'html';
+            }
+            catch (e) {
+                throw Error(`${e.message} \nFile: ${file}`);
+            }
+        }
+    }
+    function visitLink(node) {
+        if (node.children.length > 0 && node.children[0].value === '!embed') {
+            const file = node.url;
+            const combinedPath = path_2.default.normalize((0, path_1.dirname)(filePath) + '/' + file);
+            if (!fs_1.default.existsSync(combinedPath)) {
+                throw Error(`Invalid fragment specified; no such file "${combinedPath}"`);
+            }
+            const code = fs_1.default.readFileSync(combinedPath, 'utf8');
+            const markdown = processor();
+            try {
+                node.value = `<div class=\"markdown-fragment\">${markdown.processSync(code)}</div>`;
+                node.type = 'html';
+            }
+            catch (e) {
+                throw Error(`${e.message} \nFile: ${file}`);
+            }
+        }
+        if (node.children.length > 0 && node.children[0].value.indexOf('%') === 0) {
             node.value = `
       <div class="card card-bordered bg-soft-info">
         <div class="card-body">
@@ -55,23 +55,23 @@ function rehypeDocs({ filePath, tag, processor }) {
             </div>
           </div>
         </div>
-      </div>`;
-            // node.value = `<iframe
-            //   width="560"
-            //   height="315"
-            //   src="${node.url}"
-            //   frameborder="0"
-            //   allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
-            //   allowfullscreen>
-            // </iframe>`;
-            node.type = 'html';
-        }
-    }
-    return function transformer(tree) {
-        (0, unist_util_visit_1.default)(tree, 'inlineCode', visitInlineCode);
-        (0, unist_util_visit_1.default)(tree, (node) => node.type === 'link', visitLink);
-        return tree;
-    };
-}
-exports.default = rehypeDocs;
+      </div>`;
+            // node.value = `<iframe
+            //   width="560"
+            //   height="315"
+            //   src="${node.url}"
+            //   frameborder="0"
+            //   allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
+            //   allowfullscreen>
+            // </iframe>`;
+            node.type = 'html';
+        }
+    }
+    return function transformer(tree) {
+        (0, unist_util_visit_1.default)(tree, 'inlineCode', visitInlineCode);
+        (0, unist_util_visit_1.default)(tree, (node) => node.type === 'link', visitLink);
+        return tree;
+    };
+}
+exports.default = rehypeDocs;
 //# sourceMappingURL=rehypeMarkdownToHtml.js.map

package/dist/src/rehypeMarkdownToMarkdown.d.ts

@@ -1,4 +1,4 @@
-export default function rehypeDocs({ filePath }: {
-    filePath: any;
-}): any;
+export default function rehypeDocs({ filePath }: {
+    filePath: any;
+}): any;
 //# sourceMappingURL=rehypeMarkdownToMarkdown.d.ts.map

package/dist/src/rehypeMarkdownToMarkdown.js

@@ -1,73 +1,73 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-const path_1 = require("path");
-const unist_util_visit_1 = __importDefault(require("unist-util-visit"));
-const path_2 = __importDefault(require("path"));
-const utils_sh_1 = require("@goldstack/utils-sh");
-const unified_1 = __importDefault(require("unified"));
-const remark_parse_1 = __importDefault(require("remark-parse"));
-const gray_matter_1 = __importDefault(require("gray-matter"));
-function fileToMarkdownTree(filePath) {
-    const data = (0, gray_matter_1.default)((0, utils_sh_1.read)(filePath)).content;
-    const tree = (0, unified_1.default)()
-        .use(remark_parse_1.default)
-        .parse(data);
-    // eslint-disable-next-line @typescript-eslint/no-use-before-define
-    return rehypeDocs({ filePath })(tree);
-}
-function rehypeDocs({ filePath }) {
-    function visitInlineCode(node) {
-        const value = node.value;
-        if (value.startsWith('markdown:')) {
-            const file = value.substr(9);
-            const combinedPath = path_2.default.normalize((0, path_1.dirname)(filePath) + '/' + file);
-            if (!fs_1.default.existsSync(combinedPath)) {
-                throw Error(`Invalid fragment specified; no such file "${combinedPath}"`);
-            }
-            const tree = fileToMarkdownTree(combinedPath);
-            try {
-                node.children = tree.children;
-                node.value = '';
-                node.type = 'root';
-            }
-            catch (e) {
-                throw Error(`${e.message} \nFile: ${file}`);
-            }
-        }
-    }
-    function visitLink(node) {
-        if (node.children.length > 0 && node.children[0].value === '!embed') {
-            const file = node.url;
-            const path = (0, path_1.dirname)(filePath) + '/' + file;
-            if (!fs_1.default.existsSync(path)) {
-                throw Error(`Invalid fragment specified; no such file "${path}"`);
-            }
-            const tree = fileToMarkdownTree(path);
-            try {
-                node.children = tree.children;
-                node.value = '';
-                node.type = 'root';
-            }
-            catch (e) {
-                throw Error(`${e.message} \nFile: ${file}`);
-            }
-        }
-        if (node.children.length > 0 &&
-            node.children[0].value &&
-            node.children[0].value.indexOf('%') === 0) {
-            node.value = `[Video: ${node.children[0].value.substring(1)}](${node.url})`;
-            node.type = 'text';
-        }
-    }
-    return function transformer(tree) {
-        (0, unist_util_visit_1.default)(tree, 'inlineCode', visitInlineCode);
-        (0, unist_util_visit_1.default)(tree, (node) => node.type === 'link', visitLink);
-        return tree;
-    };
-}
-exports.default = rehypeDocs;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const path_1 = require("path");
+const unist_util_visit_1 = __importDefault(require("unist-util-visit"));
+const path_2 = __importDefault(require("path"));
+const utils_sh_1 = require("@goldstack/utils-sh");
+const unified_1 = __importDefault(require("unified"));
+const remark_parse_1 = __importDefault(require("remark-parse"));
+const gray_matter_1 = __importDefault(require("gray-matter"));
+function fileToMarkdownTree(filePath) {
+    const data = (0, gray_matter_1.default)((0, utils_sh_1.read)(filePath)).content;
+    const tree = (0, unified_1.default)()
+        .use(remark_parse_1.default)
+        .parse(data);
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    return rehypeDocs({ filePath })(tree);
+}
+function rehypeDocs({ filePath }) {
+    function visitInlineCode(node) {
+        const value = node.value;
+        if (value.startsWith('markdown:')) {
+            const file = value.substr(9);
+            const combinedPath = path_2.default.normalize((0, path_1.dirname)(filePath) + '/' + file);
+            if (!fs_1.default.existsSync(combinedPath)) {
+                throw Error(`Invalid fragment specified; no such file "${combinedPath}"`);
+            }
+            const tree = fileToMarkdownTree(combinedPath);
+            try {
+                node.children = tree.children;
+                node.value = '';
+                node.type = 'root';
+            }
+            catch (e) {
+                throw Error(`${e.message} \nFile: ${file}`);
+            }
+        }
+    }
+    function visitLink(node) {
+        if (node.children.length > 0 && node.children[0].value === '!embed') {
+            const file = node.url;
+            const path = (0, path_1.dirname)(filePath) + '/' + file;
+            if (!fs_1.default.existsSync(path)) {
+                throw Error(`Invalid fragment specified; no such file "${path}"`);
+            }
+            const tree = fileToMarkdownTree(path);
+            try {
+                node.children = tree.children;
+                node.value = '';
+                node.type = 'root';
+            }
+            catch (e) {
+                throw Error(`${e.message} \nFile: ${file}`);
+            }
+        }
+        if (node.children.length > 0 &&
+            node.children[0].value &&
+            node.children[0].value.indexOf('%') === 0) {
+            node.value = `[Video: ${node.children[0].value.substring(1)}](${node.url})`;
+            node.type = 'text';
+        }
+    }
+    return function transformer(tree) {
+        (0, unist_util_visit_1.default)(tree, 'inlineCode', visitInlineCode);
+        (0, unist_util_visit_1.default)(tree, (node) => node.type === 'link', visitLink);
+        return tree;
+    };
+}
+exports.default = rehypeDocs;
 //# sourceMappingURL=rehypeMarkdownToMarkdown.js.map

package/dist/src/resolveMarkdown.d.ts

@@ -1,2 +1,2 @@
-export declare function resolveMarkdown(filePath: string): Promise<string>;
+export declare function resolveMarkdown(filePath: string): Promise<string>;
 //# sourceMappingURL=resolveMarkdown.d.ts.map

package/dist/src/resolveMarkdown.js

@@ -1,37 +1,37 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveMarkdown = void 0;
-const unified_1 = __importDefault(require("unified"));
-const remark_parse_1 = __importDefault(require("remark-parse"));
-const rehypeMarkdownToMarkdown_1 = __importDefault(require("./rehypeMarkdownToMarkdown"));
-// import stringify from 'rehype-stringify';
-const mdast_util_to_markdown_1 = __importDefault(require("mdast-util-to-markdown"));
-const mdast_util_gfm_table_1 = __importDefault(require("mdast-util-gfm-table"));
-const gray_matter_1 = __importDefault(require("gray-matter"));
-const utils_sh_1 = require("@goldstack/utils-sh");
-async function resolveMarkdown(filePath) {
-    try {
-        let tree = undefined;
-        tree = (0, unified_1.default)()
-            .use(remark_parse_1.default)
-            // .use(rehypeMarkdown, { filePath })
-            .parse((0, gray_matter_1.default)((0, utils_sh_1.read)(filePath)).content);
-        tree = (0, rehypeMarkdownToMarkdown_1.default)({ filePath })(tree);
-        // const file = await processor.process(md);
-        // console.log(JSON.stringify(tree, null, 2));
-        const file = (0, mdast_util_to_markdown_1.default)(tree, {
-            extensions: [mdast_util_gfm_table_1.default.toMarkdown()],
-        });
-        // Replace non-breaking spaces (char code 160) with normal spaces to avoid style issues
-        return file.replace(/\xA0/g, ' ');
-    }
-    catch (error) {
-        console.error(`Markdown to Markdown error: ${error}`);
-        throw error;
-    }
-}
-exports.resolveMarkdown = resolveMarkdown;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveMarkdown = void 0;
+const unified_1 = __importDefault(require("unified"));
+const remark_parse_1 = __importDefault(require("remark-parse"));
+const rehypeMarkdownToMarkdown_1 = __importDefault(require("./rehypeMarkdownToMarkdown"));
+// import stringify from 'rehype-stringify';
+const mdast_util_to_markdown_1 = __importDefault(require("mdast-util-to-markdown"));
+const mdast_util_gfm_table_1 = __importDefault(require("mdast-util-gfm-table"));
+const gray_matter_1 = __importDefault(require("gray-matter"));
+const utils_sh_1 = require("@goldstack/utils-sh");
+async function resolveMarkdown(filePath) {
+    try {
+        let tree = undefined;
+        tree = (0, unified_1.default)()
+            .use(remark_parse_1.default)
+            // .use(rehypeMarkdown, { filePath })
+            .parse((0, gray_matter_1.default)((0, utils_sh_1.read)(filePath)).content);
+        tree = (0, rehypeMarkdownToMarkdown_1.default)({ filePath })(tree);
+        // const file = await processor.process(md);
+        // console.log(JSON.stringify(tree, null, 2));
+        const file = (0, mdast_util_to_markdown_1.default)(tree, {
+            extensions: [mdast_util_gfm_table_1.default.toMarkdown()],
+        });
+        // Replace non-breaking spaces (char code 160) with normal spaces to avoid style issues
+        return file.replace(/\xA0/g, ' ');
+    }
+    catch (error) {
+        console.error(`Markdown to Markdown error: ${error}`);
+        throw error;
+    }
+}
+exports.resolveMarkdown = resolveMarkdown;
 //# sourceMappingURL=resolveMarkdown.js.map

package/dist/src/utilsDocs.d.ts

@@ -1,8 +1,8 @@
-export { markdownToHtml } from './markdownToHtml';
-export { resolveMarkdown } from './resolveMarkdown';
-export interface RenderPageResult {
-    html: string;
-    data: any;
-}
-export declare const renderPage: (filePath: string) => Promise<RenderPageResult>;
+export { markdownToHtml } from './markdownToHtml';
+export { resolveMarkdown } from './resolveMarkdown';
+export interface RenderPageResult {
+    html: string;
+    data: any;
+}
+export declare const renderPage: (filePath: string) => Promise<RenderPageResult>;
 //# sourceMappingURL=utilsDocs.d.ts.map

package/dist/src/utilsDocs.js

@@ -1,25 +1,25 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.renderPage = exports.resolveMarkdown = exports.markdownToHtml = void 0;
-const gray_matter_1 = __importDefault(require("gray-matter"));
-const utils_sh_1 = require("@goldstack/utils-sh");
-const markdownToHtml_1 = require("./markdownToHtml");
-const path_1 = __importDefault(require("path"));
-var markdownToHtml_2 = require("./markdownToHtml");
-Object.defineProperty(exports, "markdownToHtml", { enumerable: true, get: function () { return markdownToHtml_2.markdownToHtml; } });
-var resolveMarkdown_1 = require("./resolveMarkdown");
-Object.defineProperty(exports, "resolveMarkdown", { enumerable: true, get: function () { return resolveMarkdown_1.resolveMarkdown; } });
-const renderPage = async (filePath) => {
-    const fileContent = (0, utils_sh_1.read)(filePath);
-    const { data, content } = (0, gray_matter_1.default)(fileContent);
-    const result = await (0, markdownToHtml_1.markdownToHtml)(path_1.default.resolve(filePath), data, content);
-    return {
-        html: result,
-        data,
-    };
-};
-exports.renderPage = renderPage;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderPage = exports.resolveMarkdown = exports.markdownToHtml = void 0;
+const gray_matter_1 = __importDefault(require("gray-matter"));
+const utils_sh_1 = require("@goldstack/utils-sh");
+const markdownToHtml_1 = require("./markdownToHtml");
+const path_1 = __importDefault(require("path"));
+var markdownToHtml_2 = require("./markdownToHtml");
+Object.defineProperty(exports, "markdownToHtml", { enumerable: true, get: function () { return markdownToHtml_2.markdownToHtml; } });
+var resolveMarkdown_1 = require("./resolveMarkdown");
+Object.defineProperty(exports, "resolveMarkdown", { enumerable: true, get: function () { return resolveMarkdown_1.resolveMarkdown; } });
+const renderPage = async (filePath) => {
+    const fileContent = (0, utils_sh_1.read)(filePath);
+    const { data, content } = (0, gray_matter_1.default)(fileContent);
+    const result = await (0, markdownToHtml_1.markdownToHtml)(path_1.default.resolve(filePath), data, content);
+    return {
+        html: result,
+        data,
+    };
+};
+exports.renderPage = renderPage;
 //# sourceMappingURL=utilsDocs.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@goldstack/utils-docs",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Utilities for working with Markdown documentation",
   "keywords": [
     "goldstack",
@@ -40,7 +40,7 @@
     "version:apply:force": "yarn version $@ && yarn version apply"
   },
   "dependencies": {
-    "@goldstack/utils-sh": "0.5.0",
+    "@goldstack/utils-sh": "0.5.1",
     "@mapbox/rehype-prism": "0.3.1",
     "github-slugger": "1.2.0",
     "gray-matter": "^4.0.2",
@@ -57,7 +57,7 @@
     "unist-util-visit": "2.0.0"
   },
   "devDependencies": {
-    "@goldstack/utils-git": "0.2.0",
+    "@goldstack/utils-git": "0.2.1",
     "@types/jest": "^28.1.8",
     "@types/node": "^18.7.13",
     "jest": "^28.1.0",