markdown-magic 3.4.2 → 3.6.1

package/README.md

@@ -19,7 +19,7 @@ This `README.md` is generated with `markdown-magic` [view the raw file](https://
 [Video demo](http://www.youtube.com/watch?v=4V2utrvxwJ8) • [Example Repo](https://github.com/DavidWells/repo-using-markdown-magic)
 
 ## Table of Contents
-<!-- ⛔️ MD-MAGIC-EXAMPLE:START TOC collapse=true collapseText="Click to expand" -->
+<!-- ⛔️ MD-MAGIC-EXAMPLE:START TOC collapseText="Click to expand" -->
 <details>
 <summary>Click to expand</summary>
 
@@ -108,7 +108,7 @@ If you have a `markdown.config.js` file where `markdown-magic` is invoked, it wi
 ### Running programmatically
 
 ```js
-const { markdownMagic } = require('../lib')
+const { markdownMagic } = require('../src')
 
 /* By default all .md files in cwd will be processed */
 markdownMagic().then((results) => {
@@ -185,7 +185,7 @@ content to be replaced
 ```
 <!-- ⛔️ MD-MAGIC-EXAMPLE:END *-->
 
-<!-- ⛔️ MD-MAGIC-EXAMPLE:START JSDocs path="./lib/index.js" -->
+<!-- ⛔️ MD-MAGIC-EXAMPLE:START JSDocs path="./src/index.js" -->
 ### API
 
 Markdown Magic Instance
@@ -231,7 +231,9 @@ Below is the main config for `markdown-magic`
 | `dryRun` (optional) | `boolean` | See planned execution of matched blocks. Default: `false` |
 | `debug` (optional) | `boolean` | See debug details. Default: `false` |
 | `silent` (optional) | `boolean` | Silence all console output. Default: `false` |
+| `applyTransformsToSource` (optional) | `boolean` | Apply transforms to source file. Default is true. Default: `true` |
 | `failOnMissingTransforms` (optional) | `boolean` | Fail if transform functions are missing. Default skip blocks. Default: `false` |
+| `failOnMissingRemote` (optional) | `boolean` | Fail if remote file is missing. Default: `true` |
 
 #### `OutputConfig`
 
@@ -259,15 +261,15 @@ Result of markdown processing
 
 Markdown Magic comes with a couple of built-in transforms for you to use or you can extend it with your own transforms. See 'Custom Transforms' below.
 
-<!-- ⛔️ MD-MAGIC-EXAMPLE:START JSDocs path="./lib/transforms/index.js" -->
+<!-- ⛔️ MD-MAGIC-EXAMPLE:START JSDocs path="./src/transforms/index.js" -->
 ### > TOC
 
 Generate table of contents from markdown file
 
 **Options:**
 - `firsth1` - *boolean* - (optional): Show first h1 of doc in table of contents. Default `false`
-- `collapse` - *boolean* - (optional): Collapse the table of contents in a detail accordian. Default `false`
-- `collapseText` - *string* - (optional): Text the toc accordian summary
+- `collapse` - *boolean* - (optional): Collapse the table of contents in a detail accordion. Default `false`
+- `collapseText` - *string* - (optional): Text the toc accordion summary
 - `excludeText` - *string* - (optional): Text to exclude in the table of contents. Default `Table of Contents`
 - `maxDepth` - *number* - (optional): Max depth of headings. Default 4
 
@@ -278,7 +280,7 @@ toc will be generated here
 <!-- end-doc-gen -->
 ```
 
-Default `MATCHWORD` is `AUTO-GENERATED-CONTENT`
+Default `matchWord` is `doc-gen`
 
 ---
 
@@ -305,12 +307,12 @@ This content will be dynamically replaced with code from the file
 ```
 
 ```md
-<!-- doc-gen CODE src="./relative/path/to/code.js" lines=22-44 -->
-This content will be dynamically replaced with code from the file lines 22 through 44
-<!-- end-doc-gen -->
-```
+ <!-- doc-gen CODE src="./relative/path/to/code.js" lines=22-44 -->
+ This content will be dynamically replaced with code from the file lines 22 through 44
+ <!-- end-doc-gen -->
+ ```
 
-Default `MATCHWORD` is `AUTO-GENERATED-CONTENT`
+Default `matchWord` is `doc-gen`
 
 ---
 
@@ -333,7 +335,7 @@ This content will be dynamically replaced from the local file
 <!-- end-doc-gen -->
 ```
 
-Default `MATCHWORD` is `AUTO-GENERATED-CONTENT`
+Default `matchWord` is `doc-gen`
 
 ---
 
@@ -356,7 +358,7 @@ This content will be dynamically replaced from the remote url
 <!-- end-doc-gen -->
 ```
 
-Default `MATCHWORD` is `AUTO-GENERATED-CONTENT`
+Default `matchWord` is `doc-gen`
 
 ---
 
@@ -414,8 +416,8 @@ The below code is used to generate **this markdown file** via the plugin system.
 const path = require('path')
 const { readFileSync } = require('fs')
 const { parseComments } = require('doxxx')
-const { markdownMagic } = require('../lib')
-const { deepLog } = require('../lib/utils/logs')
+const { markdownMagic } = require('../src')
+const { deepLog } = require('../src/utils/logs')
 
 const config = {
   matchWord: 'MD-MAGIC-EXAMPLE', // default matchWord is AUTO-GENERATED-CONTENT

package/cli.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 const mri = require('mri')
-const { runCli } = require('./lib/cli')
+const { runCli } = require('./src/cli')
 const argv = process.argv.slice(2)
 const cliArgs = mri(argv)
 

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "markdown-magic",
-  "version": "3.4.2",
+  "version": "3.6.1",
   "description": "Automatically update markdown files with content from external sources",
-  "main": "lib/index.js",
+  "main": "src/index.js",
   "bin": {
     "markdown": "./cli.js",
     "md-magic": "./cli.js",
@@ -13,23 +13,23 @@
     "package.json",
     "package-lock.json",
     "cli.js",
-    "/lib"
+    "src"
   ],
   "scripts": {
     "types": "tsc",
     "emit-types": "tsc --noEmit false --emitDeclarationOnly true",
     "docs": "node examples/generate-readme.js",
-    "test": "npm run test:lib && npm run test:test && echo 'tests done'",
-    "test:lib": "uvu lib '.test.([mc]js|[jt]sx?)$'",
+    "test": "npm run test:src && npm run test:test && echo 'tests done'",
+    "test:src": "uvu src '.test.([mc]js|[jt]sx?)$'",
     "test:test": "uvu test '.test.([mc]js|[jt]sx?)$'",
-    "test:block": "uvu lib 'block-parser.test.([mc]js|[jt]sx?)$'",
-    "test:cli": "uvu lib 'cli.test.([mc]js|[jt]sx?)$'",
-    "test:md": "uvu lib 'md.test.([mc]js|[jt]sx?)$'",
-    "test:fs": "uvu lib 'fs.test.([mc]js|[jt]sx?)$'",
-    "test:js": "uvu lib 'block-parser-js.test.([mc]js|[jt]sx?)$'",
+    "test:block": "uvu src 'block-parser.test.([mc]js|[jt]sx?)$'",
+    "test:cli": "uvu src 'cli.test.([mc]js|[jt]sx?)$'",
+    "test:md": "uvu src 'md.test.([mc]js|[jt]sx?)$'",
+    "test:fs": "uvu src 'fs.test.([mc]js|[jt]sx?)$'",
+    "test:js": "uvu src 'block-parser-js.test.([mc]js|[jt]sx?)$'",
     "test:errors": "uvu test 'errors.test.([mc]js|[jt]sx?)$'",
     "test:transforms": "uvu test 'transforms.test.([mc]js|[jt]sx?)$'",
-    "test:text": "uvu lib 'text.test.([mc]js|[jt]sx?)$'",
+    "test:text": "uvu src 'text.test.([mc]js|[jt]sx?)$'",
     "cli": "node ./cli.js --path 'README.md' --config ./markdown.config.js",
     "publish": "git push origin && git push origin --tags",
     "release:patch": "npm version patch && npm publish",
@@ -44,7 +44,7 @@
     "url": "https://github.com/DavidWells/markdown-magic"
   },
   "dependencies": {
-    "@davidwells/md-utils": "^0.0.46",
+    "@davidwells/md-utils": "0.0.52",
     "globrex": "^0.1.2",
     "gray-matter": "^4.0.3",
     "is-glob": "^4.0.3",

package/{lib → src}/block-parser.js

@@ -139,6 +139,8 @@ Details:
     // console.log('openEnd', openEnd)
     // console.log('options', options)
 
+    // context.hasNoBlankLine = content.indexOf('\n') === -1
+
     const blockData = {
       index: blockIndex,
       type: transformType,
@@ -180,6 +182,8 @@ Details:
     newBlocks.push(blockData)
   }
 
+  // console.log("NEW BLOCKS", newBlocks)
+  // process.exit(1)
   return {
     // Close but no single line newPattern: newGetBlockRegex({ openComment, commentClose, start: START, ending: END }),
     // pattern: regexToUse,

package/{lib → src}/index.js

@@ -19,7 +19,7 @@ const { parseMarkdown } = require('@davidwells/md-utils')
 const { success, error, info, convertHrtime, deepLog } = require('./utils/logs')
 const { OPEN_WORD, CLOSE_WORD, DEFAULT_GLOB_PATTERN } = require('./defaults')
 const { getBlockRegex, parseBlocks } = require('./block-parser')
-const toposort = require('./utils/toposort');
+const toposort = require('./utils/toposort')
 // const { hashFile } = require('./utils/hash-file')
 // const { getBlockRegex } = require('./block-parser')
 // const diff = require('../misc/old-test/utils/diff')

package/{lib → src}/process-contents.js

@@ -105,6 +105,7 @@ async function processContents(text, config) {
     /* Apply Before middleware to all transforms */
     const match = await applyMiddleware(originalMatch, md, beforeMiddleware)
     const { block, content, open, close, transform, options, context } = match
+    // console.log("MATCH", match)
     const closeTag = close.value
     const openTag = open.value
     
@@ -151,6 +152,7 @@ async function processContents(text, config) {
 
       // console.log('returnedContent', returnedContent)
       // process.exit(1)
+
      
       if (returnedContent) {
         tempContent = returnedContent
@@ -207,8 +209,27 @@ async function processContents(text, config) {
       preserveIndent = block.indentation.length
     }
     // console.log('preserveIndent', preserveIndent)
-    const indent = indentString(fix, preserveIndent)
-    const newCont = `${openTag}${indent}${closeTag}`
+    let addTrailingNewline = ''
+    if (context.isMultiline && !fix.endsWith('\n') && fix !== '' && closeTag.indexOf('\n') === -1) {
+      addTrailingNewline = '\n'
+    }
+
+    let addLeadingNewline = ''
+    if (context.isMultiline && !fix.startsWith('\n') && fix !== '' && openTag.indexOf('\n') === -1) {
+      addLeadingNewline = '\n'
+    }
+
+    let fixWrapper = ''
+    /* If block wasn't multiline but the contents ARE multiline fix the block */
+    if (!context.isMultiline && fix.indexOf('\n') > -1) {
+      fixWrapper = '\n'
+    }
+
+    // console.log("OPEN TAG", `"${openTag}"`)
+    // console.log("CLOSE TAG", `"${closeTag}"`)
+    
+    const indent = addLeadingNewline + indentString(fix, preserveIndent) + addTrailingNewline
+    const newCont = `${openTag}${fixWrapper}${indent}${fixWrapper}${closeTag}`
     /* Replace original contents */
     // Must use replacer function because strings get coerced to regex or something
     const newContents = md.replace(block.value, () => newCont)
@@ -257,6 +278,9 @@ async function processContents(text, config) {
 
   // console.log('srcPath', srcPath)
   // console.log('outputPath', outputPath)
+  // console.log('updatedContents', updatedContents)
+  // console.log('text', text)
+  // process.exit(1)
   const result = {
     /* Has markdown content changed? */
     isChanged: text !== updatedContents,
@@ -415,8 +439,8 @@ function sortTranforms(foundTransForms, registeredTransforms) {
   if (!foundTransForms) return []
   return foundTransForms.sort((a, b) => {
     // put table of contents (TOC) at end of tranforms
-    if (a.transform === 'TOC') return 1
-    if (b.transform === 'TOC') return -1
+    if (a.transform === 'TOC' || a.transform === 'sectionToc') return 1
+    if (b.transform === 'TOC' || b.transform === 'sectionToc') return -1
     return 0
   }).map((item) => {
     if (getTransform(item.transform, registeredTransforms)) {

package/{lib → src}/transforms/file.js

@@ -1,8 +1,7 @@
 const path = require('path')
 const fs = require('fs')
 const isLocalPath = require('is-local-path')
-const { findFrontmatter } = require('@davidwells/md-utils/find-frontmatter')
-const { removeLeadingH1 } = require('@davidwells/md-utils/string-utils')
+const { formatMd } = require('../utils/format-md')
 
 module.exports = function FILE(api) {
   /*
@@ -32,27 +31,11 @@ module.exports = function FILE(api) {
   // trim leading and trailing spaces/line breaks in code and keeps the indentation of the first non-empty line
   fileContents = fileContents.replace(/^(?:[\t ]*(?:\r?\n|\r))+|\s+$/g, '')
 
-  if (options.removeLeadingH1) {
-    fileContents = removeLeadingH1(fileContents)
-  }
-
-  const isMarkdown = path.extname(options.src).toLowerCase() === '.md'
-  // Shift headers up or down by the specified number of levels if shiftHeaders is enabled and file is markdown
-  if (options.shiftHeaders && isMarkdown) {
-    fileContents = fileContents.replace(/^(#{1,6})\s/gm, (match, hashes) => {
-      const currentLevel = hashes.length;
-      const shiftAmount = options.shiftHeaders;
-      const newLevel = Math.max(1, Math.min(6, currentLevel + shiftAmount));
-      return '#'.repeat(newLevel) + ' ';
-    })
-  }
-
-  /* automatically trim frontmatter if file is markdown */
-  if (isMarkdown && options.trimFrontmatter !== false) {
-    const frontmatter = findFrontmatter(fileContents)
-    if (frontmatter && frontmatter.frontMatterRaw) {
-      fileContents = fileContents.replace(frontmatter.frontMatterRaw, '')
-    }
+  const ext = path.extname(options.src).toLowerCase()
+  const isMarkdown = ext === '.md' || ext === '.markdown' || ext === '.mdown' || ext === '.mdx'
+  
+  if (isMarkdown) {
+    fileContents = formatMd(fileContents, options)
   }
 
   if (options.textBefore) {

package/{lib → src}/transforms/index.js

@@ -2,6 +2,7 @@ const code = require('./code')
 const file = require('./file')
 const remoteContent = require('./remote')
 const toc = require('./toc')
+const sectionToc = require('./sectionToc')
 
 const transforms = {
   /**
@@ -11,8 +12,8 @@ const transforms = {
    *
    * **Options:**
    * - `firsth1` - *boolean* - (optional): Show first h1 of doc in table of contents. Default `false`
-   * - `collapse` - *boolean* - (optional): Collapse the table of contents in a detail accordian. Default `false`
-   * - `collapseText` - *string* - (optional): Text the toc accordian summary
+   * - `collapse` - *boolean* - (optional): Collapse the table of contents in a detail accordion. Default `false`
+   * - `collapseText` - *string* - (optional): Text the toc accordion summary
    * - `excludeText` - *string* - (optional): Text to exclude in the table of contents. Default `Table of Contents`
    * - `maxDepth` - *number* - (optional): Max depth of headings. Default 4
    *
@@ -23,7 +24,7 @@ const transforms = {
    * <!-- end-doc-gen -->
    * ```
    *
-   * Default `MATCHWORD` is `AUTO-GENERATED-CONTENT`
+   * Default `matchWord` is `doc-gen`
    *
    * ---
    * @param {string} content The current content of the comment block
@@ -31,6 +32,7 @@ const transforms = {
    * @return {string} Updated content to place in the content block
    */
   TOC: toc,
+  sectionToc: sectionToc,
   /**
    * ### > CODE
    *
@@ -55,7 +57,7 @@ const transforms = {
    *  <!-- end-doc-gen -->
    *  ```
    * 
-   * Default `MATCHWORD` is `AUTO-GENERATED-CONTENT`
+   * Default `matchWord` is `doc-gen`
    *
    * ---
    * @param {string} content The current content of the comment block
@@ -78,7 +80,7 @@ const transforms = {
    * <!-- end-doc-gen -->
    * ```
    *
-   * Default `MATCHWORD` is `AUTO-GENERATED-CONTENT`
+   * Default `matchWord` is `doc-gen`
    *
    * ---
    * @param {string} content The current content of the comment block
@@ -101,7 +103,7 @@ const transforms = {
    * <!-- end-doc-gen -->
    * ```
    *
-   * Default `MATCHWORD` is `AUTO-GENERATED-CONTENT`
+   * Default `matchWord` is `doc-gen`
    *
    * ---
    * @param {string} content The current content of the comment block

package/{lib → src}/transforms/remote.js

@@ -1,18 +1,30 @@
+const path = require('path')
 const { remoteRequest } = require('../utils/remoteRequest')
+const { formatMd } = require('../utils/format-md')
 
 module.exports = async function REMOTE(api) {
   // console.log('REMOTE api', api)
   const { options, content, settings } = api
   const { regex } = settings
+  const remoteUrl = options.url || options.src || options.URL || options.Url
 
   // console.log('MAKE REMOTE REQUEST')
-  const remoteContent = await remoteRequest(options.url, settings, api.srcPath)
+  let remoteContent = await remoteRequest(remoteUrl, settings, api.srcPath)
   if (!remoteContent) {
     return content
   }
+
+  const ext = path.extname(remoteUrl).toLowerCase()
+  const isMarkdown = ext === '.md' || ext === '.markdown' || ext === '.mdown' || ext === '.mdx'
+  
+  if (isMarkdown) {
+    remoteContent = formatMd(remoteContent, options)
+  }
+
   if (options.keepComments) {
     return remoteContent
   }
+  
   // console.log('REMOTE', remoteContent)
   return remoteContent.replace(regex.open, '').replace(regex.close, '')
 }

package/src/transforms/sectionToc.js

@@ -0,0 +1,37 @@
+// const { generateToc } = require('../utils/toc')
+const { generateToc } = require('@davidwells/md-utils')
+const { findClosestParentHeading } = require('@davidwells/md-utils/find-headings')
+const { readFile } = require('../utils/fs')
+const details = require('../utils/details')
+
+module.exports = async function sectionToc(api) {
+  const { options, currentFileContent, originalFileContent, srcPath, getBlockDetails } = api
+  const opts = options || {}
+  let { collapseText, collapse } = opts
+  /* Sub table of contents */
+  const originalBlock = getBlockDetails(originalFileContent)
+  const closestHeading = findClosestParentHeading(originalFileContent, originalBlock.block.start)
+  // console.log('closestHeading', closestHeading)
+  
+  const subToc = await generateToc(currentFileContent, {
+    ...opts,
+    normalizeLevels: true,
+    // Set sub table of contents
+    subSection: closestHeading,
+  })
+
+  if (closestHeading) {
+    const headingText = closestHeading.text
+    // console.log('BEFORE', linesBefore)
+    // console.log('closest parent heading', closestHeading)
+    // console.log('headingText', headingText)
+    collapseText = collapseText || `${headingText} contents`
+    // https://regex101.com/r/MB85zm/1
+  }
+
+  if (collapse || collapseText) {
+    return details(subToc.text, collapseText)
+  }
+
+  return subToc.text
+}

package/src/transforms/toc.js

@@ -0,0 +1,107 @@
+const { generateToc } = require('@davidwells/md-utils')
+const { removeLeadingAndTrailingLineBreaks, escapeRegexString } = require('../utils/regex')
+const sectionToc = require('./sectionToc')
+/**
+ * Options for configuring the table of contents.
+ * @typedef {Object} ToCTransformOptions
+ * @property {boolean} [firsth1=false] - Show the first h1 of the document in the table of contents. Default is `false`.
+ * @property {boolean} [collapse=false] - Collapse the table of contents in a detail accordion. Default is `false`.
+ * @property {string} [collapseText] - Text for the summary of the table of contents accordion.
+ * @property {string} [excludeText="Table of Contents"] - Text to exclude in the table of contents. Default is `Table of Contents`.
+ * @property {number} [maxDepth=4] - Maximum depth of headings to include in the table of contents. Default is `4`.
+ * @example
+   ```md
+   <!-- doc-gen (TOC) -->
+   toc will be generated here
+   <!-- end-doc-gen -->
+   ``` 
+ */
+
+module.exports = async function TOC(api) {
+  // console.log("TOC API", api)
+  const { currentFileContent, srcPath, getBlockDetails } = api
+  /** @type {ToCTransformOptions} */
+  const options = api.options || {}
+  // console.log("TOC OPTIONS", options)
+
+  // process.exit(1)
+  const opts = options || {}
+  const includeToc = opts.includeToc || false
+  const isSub = opts.sub
+
+  if (isSub) {
+    return sectionToc(api)
+  }
+
+  opts.firsth1 = (opts.firsth1) ? true : false
+  let contents = currentFileContent
+  // console.log('contents', contents)
+
+  let collapseText = opts.collapseText
+
+  let debugFileMatch
+  // console.log('config', config.originalPath)
+  // debugFileMatch = config.originalPath.match(/packages\/analytics\/README\.md/)
+
+  // https://www.npmjs.com/package/@technote-space/toc-generator
+  const tocOptions = {
+    // mode: 'github.com', // github.com | bitbucket.org | gitlab.com | nodejs.org | ghost.org (default: github.com)
+    //isCustomMode: true,
+    openingComment: '',
+    closingComment: '',
+    maxDepth: (opts.maxDepth) ? Number(opts.maxDepth) : 4,
+    normalizeLevels: true,
+    trimLeadingHeading: true,
+    // maxHeaderLevel: 2, // default: 4
+    // title: '**Table of Contents**',
+    // isNotitle: true,
+    // isFolding: true,
+    // entryPrefix: '*',
+    // processAll: true,
+    // updateOnly: true,
+    // openingComment: '<!-- toc -->',
+    // closingComment: '<!-- tocstop --> ',
+    // checkOpeningComments: ['<!-- toc '],
+    // checkClosingComments: ['<!-- tocstop '],
+    // isCustomMode: false,
+    // customTemplate: '<p align="center">${ITEMS}</p>',
+    // itemTemplate: '<a href="${LINK}">${TEXT}</a>',
+    // separator: '<span>|</span>',
+    // footer: 'end',
+  }
+
+  /* Exclude Table of contents section from toc */
+  if (!includeToc) {
+    tocOptions.filter = (item) => {
+      const text = item.text.trim().toLowerCase()
+      return text !== 'table of contents' && text !== 'toc'
+    }
+  }
+
+  const tocObject = generateToc(contents, tocOptions)
+  // console.log("TOC OPTIONS", contents)
+  // console.log("TOC OBJECT", tocObject)
+  // process.exit(1)
+  //  let outputText = t.wrappedToc || ''
+  let outputText = tocObject.text || ''
+
+  // console.log('outputText')
+  // console.log(outputText)
+  //process.exit(1)
+
+    // If collapse wrap in <details>
+  if (opts.collapse || opts.collapseText) {
+    return `<details>
+<summary>${collapseText || 'Table of Contents'}</summary>
+
+${outputText   
+  // Replace leading double spaces
+  .replace(/^\n*/g, '')
+  // Replace trailing double spaces
+  .replace(/\n*$/g, '')
+}
+
+</details>`
+  }
+  return outputText.replace(removeLeadingAndTrailingLineBreaks, '')
+}

package/src/utils/details.js

@@ -0,0 +1,15 @@
+function details(text, title) {
+   const summaryRender = title ? `\n<summary>${title}</summary>` : ''
+   return `<details>${summaryRender}
+
+${text
+  // Replace leading double spaces
+  .replace(/^\n*/g, '')
+  // Replace trailing double spaces
+  .replace(/\n*$/g, '')
+}
+
+</details>`
+}
+
+module.exports = details

package/src/utils/format-md.js

@@ -0,0 +1,33 @@
+const { findFrontmatter } = require('@davidwells/md-utils/find-frontmatter')
+const { removeLeadingH1 } = require('@davidwells/md-utils/string-utils')
+
+function formatMd(content, options = {}) {
+  let fileContents = content
+  if (options.removeLeadingH1) {
+    fileContents = removeLeadingH1(fileContents)
+  }
+  
+  // Shift headers up or down by the specified number of levels if shiftHeaders is enabled and file is markdown
+  if (options.shiftHeaders) {
+    fileContents = fileContents.replace(/^(#{1,6})\s/gm, (match, hashes) => {
+      const currentLevel = hashes.length;
+      const shiftAmount = options.shiftHeaders;
+      const newLevel = Math.max(1, Math.min(6, currentLevel + shiftAmount));
+      return '#'.repeat(newLevel) + ' ';
+    })
+  }
+
+  /* automatically trim frontmatter if file is markdown */
+  if (options.trimFrontmatter !== false) {
+    const frontmatter = findFrontmatter(fileContents)
+    if (frontmatter && frontmatter.frontMatterRaw) {
+      fileContents = fileContents.replace(frontmatter.frontMatterRaw, '')
+    }
+  }
+
+  return fileContents
+}
+
+module.exports = {
+  formatMd
+}

package/{lib → src}/utils/toc.js

@@ -1,4 +1,4 @@
-const { generateToc : generateTocUtils } = require('@davidwells/md-utils')
+const { generateToc } = require('@davidwells/md-utils')
 const { removeLeadingAndTrailingLineBreaks, escapeRegexString } = require('./regex')
 const { findMinIndent } = require('./text')
 const { readFile } = require('./fs')
@@ -28,7 +28,7 @@ const { readFile } = require('./fs')
  * @param {TocAPI} api 
  * @returns 
  */
-async function generateToc({
+async function odlGenerateToc({
   options = {},
   fileContent,
   srcPath,
@@ -57,7 +57,9 @@ async function generateToc({
     //isCustomMode: true,
     openingComment: '',
     closingComment: '',
-    maxHeaderLevel: (opts.maxDepth) ? Number(opts.maxDepth) : 4,
+    maxDepth: (opts.maxDepth) ? Number(opts.maxDepth) : 4,
+    normalizeLevels: true,
+    trimLeadingHeading: true,
     // maxHeaderLevel: 2, // default: 4
     // title: '**Table of Contents**',
     // isNotitle: true,
@@ -75,12 +77,35 @@ async function generateToc({
     // separator: '<span>|</span>',
     // footer: 'end',
   }
-
-  const tocObject = generateTocUtils(contents)
-
+  // console.log("TOC OPTIONS", contents)
+  const tocObject = generateTocUtils(contents, tocOptions)
+  // console.log("TOC OBJECT", tocObject)
+  // process.exit(1)
   //  let outputText = t.wrappedToc || ''
   let outputText = tocObject.text || ''
 
+  console.log('outputText')
+  console.log(outputText)
+  //process.exit(1)
+
+    // If collapse wrap in <details>
+  if (opts.collapse) {
+    return `<details>
+<summary>${collapseText || 'Table of Contents'}</summary>
+
+${outputText   
+  // Replace leading double spaces
+  .replace(/^\n*/g, '')
+  // Replace trailing double spaces
+  .replace(/\n*$/g, '')
+}
+
+</details>`
+  }
+  console.log("OUTPUT TEXT", outputText)
+  return outputText.replace(removeLeadingAndTrailingLineBreaks, '')
+  process.exit(1)
+
   if (debugFileMatch) {
     console.log('before firsth1 removal', outputText)
   }
@@ -282,6 +307,7 @@ ${outputText
 
 </details>`
   }
+  console.log("OUTPUT TEXT", outputText)
   return outputText.replace(removeLeadingAndTrailingLineBreaks, '')
 }
 
@@ -315,5 +341,5 @@ function excludeTocItem(str, excludeText) {
 }
 
 module.exports = {
-  generateToc
+  odlGenerateToc
 }

package/lib/transforms/sectionToc.js

@@ -1,18 +0,0 @@
-const { generateToc } = require('../utils/toc')
-
-module.exports = async function sectionToc(api) {
-  // console.log("sectionToc", api)
-  const { options, currentFileContent, srcPath, getBlockDetails } = api
-  const opts = options || {}
-  const subToc = await generateToc({
-    options: {
-      ...opts,
-      // Set sub table of contents
-      sub: true
-    },
-    fileContent: currentFileContent,
-    srcPath,
-    getBlockDetails: getBlockDetails
-  })
-  return subToc
-}

package/lib/transforms/toc.js

@@ -1,31 +0,0 @@
-const { generateToc } = require('../utils/toc')
-
-/**
- * Options for configuring the table of contents.
- * @typedef {Object} ToCTransformOptions
- * @property {boolean} [firsth1=false] - Show the first h1 of the document in the table of contents. Default is `false`.
- * @property {boolean} [collapse=false] - Collapse the table of contents in a detail accordion. Default is `false`.
- * @property {string} [collapseText] - Text for the summary of the table of contents accordion.
- * @property {string} [excludeText="Table of Contents"] - Text to exclude in the table of contents. Default is `Table of Contents`.
- * @property {number} [maxDepth=4] - Maximum depth of headings to include in the table of contents. Default is `4`.
- * @example
-   ```md
-   <!-- doc-gen (TOC) -->
-   toc will be generated here
-   <!-- end-doc-gen -->
-   ``` 
- */
-
-module.exports = async function TOC(api) {
-  // console.log("TOC API", api)
-  const { currentFileContent, srcPath, getBlockDetails } = api
-  /** @type {ToCTransformOptions} */
-  const options = api.options || {}
-  const toc = await generateToc({
-    options,
-    srcPath,
-    getBlockDetails: getBlockDetails,
-    fileContent: currentFileContent,
-  })
-  return toc
-}