{"_id":"@aaronhuggins/concat-md","_rev":"5-0d8240454756031feef96bdb47e0101c","name":"@aaronhuggins/concat-md","dist-tags":{"latest":"0.3.9"},"versions":{"0.3.6":{"name":"@aaronhuggins/concat-md","version":"0.3.6","description":"CLI and API to concatenate markdown files and modify as necessary.","publishConfig":{"access":"public"},"keywords":["concat","concatenate","merge","join","markdown","md","generator","creator","README","README.md","TypeDoc","JSDoc","FrontMatter","Meta","cms"],"engines":{"node":">=10.8.0"},"main":"dist/index.js","types":"dist/index.d.ts","bin":{"concat-md":"dist/bin/concat-md.js"},"scripts":{"build":"rm -rf dist && tsc","docs:build-md":"typedoc --plugin typedoc-plugin-example-tag,typedoc-plugin-markdown --excludeExternals --excludePrivate --excludeProtected --theme markdown --mode file --out api --readme none && ts-node src/bin/concat-md.ts --decrease-title-levels --dir-name-as-title api > API.md && rm -rf api","lint":"eslint --max-warnings=0 --ignore-path .gitignore --cache 'src/**/*.+(js|jsx|ts|tsx|vue)'","format":"prettier --write --config .prettierrc --check 'src/**/*.+(js|jsx|json|less|css|ts|tsx|md|vue|gql)'","test":"NODE_ENV=test jest --coverage","prepublishOnly":"npm run build","prerelease":"npm-run-all -p lint test format","release":"(git diff --quiet && git diff --staged --quiet || git commit -am 'format code') && git checkout master && git pull origin master && git push --follow-tags origin master && npm publish"},"repository":{"type":"git","url":"git+https://github.com/aaronhuggins/concat-md.git"},"author":{"name":"Özüm Eldoğan"},"license":"MIT","bugs":{"url":"https://github.com/aaronhuggins/concat-md/issues"},"homepage":"https://github.com/aaronhuggins/concat-md#readme","devDependencies":{"@types/jest":"^27","@types/lodash.startcase":"^4.4.6","@types/meow":"^5.0.0","@types/node":"^16.11.6","@types/prettier":"^2","@typescript-eslint/eslint-plugin":"^5","@typescript-eslint/parser":"^5","eslint":"^8","eslint-config-airbnb-base":"^14","eslint-config-prettier":"^8.3.0","eslint-plugin-import":"^2.25.2","eslint-plugin-jest":"^25","eslint-plugin-prettier":"^4.0.0","jest":"^27","npm-run-all":"^4.1.5","prettier":"^2","ts-jest":"^27.0.7","ts-node-dev":"^1.1.8","typedoc":"github:TypeStrong/typedoc","typedoc-plugin-example-tag":"^1.0.2","typedoc-plugin-markdown":"^3.11.3","typescript":"^4.4.4"},"dependencies":{"@types/globby":"^9.1.0","doctoc":"^2.1.0","front-matter":"^4.0.2","globby":"^11.0.4","install":"^0.13.0","lodash.startcase":"^4.4.0","meow":"^10.1.1","npm":"^8.1.2","transform-markdown-links":"^2.0.0"},"gitHead":"e82c4111fdb6ded4c06f275c2f303a993f5e4226","_id":"@aaronhuggins/concat-md@0.3.6","_nodeVersion":"14.17.3","_npmVersion":"6.14.13","dist":{"integrity":"sha512-O21rKHUAHx/svjAYvmQAG67Pfm7Af1w3clwrzuaTC77dpQbz5oF7KDtdOR3RXeNKJRbU3etOHxBbYsfTaDNjeg==","shasum":"fe383b832cea8db084c52148db040bd4000cb4e6","tarball":"https://registry.npmjs.org/@aaronhuggins/concat-md/-/concat-md-0.3.6.tgz","fileCount":9,"unpackedSize":37714,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC1HnOHPAofxUI5i+/xoaH9m1ALlKE3dQW21Z0Lqf6nkwIhANQLBZFPpxfwC1dmsdgz1GVdXxeir99i84XuuJ5oTn7O"}]},"_npmUser":{"name":"aaron.nuclearfamily","email":"aaron@nuclearfamily.llc"},"directories":{},"maintainers":[{"name":"aaron.nuclearfamily","email":"aaron@nuclearfamily.llc"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/concat-md_0.3.6_1635794709911_0.7162465335839407"},"_hasShrinkwrap":false},"0.3.7":{"name":"@aaronhuggins/concat-md","version":"0.3.7","description":"CLI and API to concatenate markdown files and modify as necessary.","publishConfig":{"access":"public"},"keywords":["concat","concatenate","merge","join","markdown","md","generator","creator","README","README.md","TypeDoc","JSDoc","FrontMatter","Meta","cms"],"engines":{"node":">=10.8.0"},"main":"dist/index.js","types":"dist/index.d.ts","bin":{"concat-md":"dist/bin/concat-md.js"},"scripts":{"build":"rm -rf dist && tsc","docs:build-md":"typedoc --plugin typedoc-plugin-example-tag,typedoc-plugin-markdown --excludeExternals --excludePrivate --excludeProtected --theme markdown --mode file --out api --readme none && ts-node src/bin/concat-md.ts --decrease-title-levels --dir-name-as-title api > API.md && rm -rf api","lint":"eslint --max-warnings=0 --ignore-path .gitignore --cache 'src/**/*.+(js|jsx|ts|tsx|vue)'","format":"prettier --write --config .prettierrc --check 'src/**/*.+(js|jsx|json|less|css|ts|tsx|md|vue|gql)'","test":"NODE_ENV=test jest --coverage","prepublishOnly":"npm run build","prerelease":"npm-run-all -p lint test format","release":"(git diff --quiet && git diff --staged --quiet || git commit -am 'format code') && git checkout master && git pull origin master && git push --follow-tags origin master && npm publish"},"repository":{"type":"git","url":"git+https://github.com/aaronhuggins/concat-md.git"},"author":{"name":"Özüm Eldoğan"},"license":"MIT","bugs":{"url":"https://github.com/aaronhuggins/concat-md/issues"},"homepage":"https://github.com/aaronhuggins/concat-md#readme","devDependencies":{"@types/jest":"^27","@types/lodash.startcase":"^4.4.6","@types/meow":"^5.0.0","@types/node":"^16.11.6","@types/prettier":"^2","@typescript-eslint/eslint-plugin":"^5","@typescript-eslint/parser":"^5","eslint":"^8","eslint-config-airbnb-base":"^14","eslint-config-prettier":"^8.3.0","eslint-plugin-import":"^2.25.2","eslint-plugin-jest":"^25","eslint-plugin-prettier":"^4.0.0","jest":"^27","npm-run-all":"^4.1.5","prettier":"^2","ts-jest":"^27.0.7","ts-node-dev":"^1.1.8","typedoc":"github:TypeStrong/typedoc","typedoc-plugin-example-tag":"^1.0.2","typedoc-plugin-markdown":"^3.11.3","typescript":"^4.4.4"},"dependencies":{"@types/globby":"^9.1.0","doctoc":"^2.1.0","front-matter":"^4.0.2","globby":"^11.0.4","install":"^0.13.0","lodash.startcase":"^4.4.0","meow":"^9.0.0","npm":"^8.1.2","transform-markdown-links":"^2.0.0"},"gitHead":"e82c4111fdb6ded4c06f275c2f303a993f5e4226","_id":"@aaronhuggins/concat-md@0.3.7","_nodeVersion":"14.17.3","_npmVersion":"6.14.13","dist":{"integrity":"sha512-JPI+dN0hNOJ2h/p5VuRzELvl0vyrOtPNH1Nw1hrxKu2rlkFXkLvut6cf1EJMuNYt+e2y44Gzn0/tzfHItyYUAQ==","shasum":"a0a16733f6c17769d806f4a16bde95c96c3b41b7","tarball":"https://registry.npmjs.org/@aaronhuggins/concat-md/-/concat-md-0.3.7.tgz","fileCount":9,"unpackedSize":37713,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD9kz3PoMXWYqUQC6UvBT3iGOl63MW4wJfQcwaPRx3iJQIgL4reMjr5RNKCxoIlvYcDOUm973JZp+b6ThlJoMsr3uE="}]},"_npmUser":{"name":"aaron.nuclearfamily","email":"aaron@nuclearfamily.llc"},"directories":{},"maintainers":[{"name":"aaron.nuclearfamily","email":"aaron@nuclearfamily.llc"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/concat-md_0.3.7_1635795085356_0.8063460350845546"},"_hasShrinkwrap":false},"0.3.8":{"name":"@aaronhuggins/concat-md","version":"0.3.8","description":"CLI and API to concatenate markdown files and modify as necessary.","publishConfig":{"access":"public"},"keywords":["concat","concatenate","merge","join","markdown","md","generator","creator","README","README.md","TypeDoc","JSDoc","FrontMatter","Meta","cms"],"engines":{"node":">=10.8.0"},"main":"dist/index.js","types":"dist/index.d.ts","bin":{"concat-md":"dist/bin/concat-md.js"},"scripts":{"build":"rm -rf dist && tsc","docs:build-md":"typedoc --plugin typedoc-plugin-example-tag,typedoc-plugin-markdown --excludeExternals --excludePrivate --excludeProtected --theme markdown --mode file --out api --readme none && ts-node src/bin/concat-md.ts --decrease-title-levels --dir-name-as-title api > API.md && rm -rf api","lint":"eslint --max-warnings=0 --ignore-path .gitignore --cache 'src/**/*.+(js|jsx|ts|tsx|vue)'","format":"prettier --write --config .prettierrc --check 'src/**/*.+(js|jsx|json|less|css|ts|tsx|md|vue|gql)'","test":"NODE_ENV=test jest --coverage","prepublishOnly":"npm run build","prerelease":"npm-run-all -p lint test format","release":"(git diff --quiet && git diff --staged --quiet || git commit -am 'format code') && git checkout master && git pull origin master && git push --follow-tags origin master && npm publish"},"repository":{"type":"git","url":"git+https://github.com/aaronhuggins/concat-md.git"},"author":{"name":"Özüm Eldoğan"},"license":"MIT","bugs":{"url":"https://github.com/aaronhuggins/concat-md/issues"},"homepage":"https://github.com/aaronhuggins/concat-md#readme","devDependencies":{"@types/jest":"^27","@types/lodash.startcase":"^4.4.6","@types/meow":"^5.0.0","@types/node":"^16.11.6","@types/prettier":"^2","@typescript-eslint/eslint-plugin":"^5","@typescript-eslint/parser":"^5","eslint":"^8","eslint-config-airbnb-base":"^14","eslint-config-prettier":"^8.3.0","eslint-plugin-import":"^2.25.2","eslint-plugin-jest":"^25","eslint-plugin-prettier":"^4.0.0","jest":"^27","npm-run-all":"^4.1.5","prettier":"^2","ts-jest":"^27.0.7","ts-node-dev":"^1.1.8","typedoc":"github:TypeStrong/typedoc","typedoc-plugin-example-tag":"^1.0.2","typedoc-plugin-markdown":"^3.11.3","typescript":"^4.4.4"},"dependencies":{"@types/globby":"^9.1.0","doctoc":"^2.1.0","front-matter":"^4.0.2","globby":"^11.0.4","install":"^0.13.0","lodash.startcase":"^4.4.0","meow":"^9.0.0","npm":"^8.1.2","transform-markdown-links":"^2.0.0"},"gitHead":"0080d977151a1d8de71ba9ded747427a1387add6","_id":"@aaronhuggins/concat-md@0.3.8","_nodeVersion":"14.17.3","_npmVersion":"6.14.13","dist":{"integrity":"sha512-tBkvI9vHLirHJwi9j8jkJSqdxfM4/SPzs5hzEdWdH7+RLXI0XUPv+fajW6O228D0UU1944UjJLmRok9KmpPOYA==","shasum":"3085e5011d6622386b6bff77e3d6c0fe920b93f6","tarball":"https://registry.npmjs.org/@aaronhuggins/concat-md/-/concat-md-0.3.8.tgz","fileCount":9,"unpackedSize":39424,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBksmgXBwgq9J1IfRilbvSvgU22hH4PeSXx8ueDrHqEiAiAFpzgLERstF6UH1+QD8DRe84rbG33Dcb0I/UwlKO+k1A=="}]},"_npmUser":{"name":"aaron.nuclearfamily","email":"aaron@nuclearfamily.llc"},"directories":{},"maintainers":[{"name":"aaron.nuclearfamily","email":"aaron@nuclearfamily.llc"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/concat-md_0.3.8_1635864855501_0.09826966729915454"},"_hasShrinkwrap":false},"0.3.9":{"name":"@aaronhuggins/concat-md","version":"0.3.9","description":"CLI and API to concatenate markdown files and modify as necessary.","publishConfig":{"access":"public"},"keywords":["concat","concatenate","merge","join","markdown","md","generator","creator","README","README.md","TypeDoc","JSDoc","FrontMatter","Meta","cms"],"engines":{"node":">=10.8.0"},"main":"dist/index.js","types":"dist/index.d.ts","bin":{"concat-md":"dist/bin/concat-md.js"},"scripts":{"build":"rm -rf dist && tsc","docs:build-md":"typedoc --plugin typedoc-plugin-example-tag,typedoc-plugin-markdown --excludeExternals --excludePrivate --excludeProtected --theme markdown --mode file --out api --readme none && ts-node src/bin/concat-md.ts --decrease-title-levels --dir-name-as-title api > API.md && rm -rf api","lint":"eslint --max-warnings=0 --ignore-path .gitignore --cache 'src/**/*.+(js|jsx|ts|tsx|vue)'","format":"prettier --write --config .prettierrc --check 'src/**/*.+(js|jsx|json|less|css|ts|tsx|md|vue|gql)'","test":"NODE_ENV=test jest --coverage","prepublishOnly":"npm run build","prerelease":"npm-run-all -p lint test format","release":"(git diff --quiet && git diff --staged --quiet || git commit -am 'format code') && git checkout master && git pull origin master && git push --follow-tags origin master && npm publish"},"repository":{"type":"git","url":"git+https://github.com/aaronhuggins/concat-md.git"},"author":{"name":"Özüm Eldoğan"},"license":"MIT","bugs":{"url":"https://github.com/aaronhuggins/concat-md/issues"},"homepage":"https://github.com/aaronhuggins/concat-md#readme","devDependencies":{"@types/jest":"^27","@types/lodash.startcase":"^4.4.6","@types/meow":"^5.0.0","@types/node":"^16.11.6","@types/prettier":"^2","@typescript-eslint/eslint-plugin":"^5","@typescript-eslint/parser":"^5","eslint":"^8","eslint-config-airbnb-base":"^14","eslint-config-prettier":"^8.3.0","eslint-plugin-import":"^2.25.2","eslint-plugin-jest":"^25","eslint-plugin-prettier":"^4.0.0","jest":"^27","npm-run-all":"^4.1.5","prettier":"^2","ts-jest":"^27.0.7","ts-node-dev":"^1.1.8","typedoc":"github:TypeStrong/typedoc","typedoc-plugin-example-tag":"^1.0.2","typedoc-plugin-markdown":"^3.11.3","typescript":"^4.4.4"},"dependencies":{"@types/globby":"^9.1.0","doctoc":"^2.1.0","front-matter":"^4.0.2","globby":"^11.0.4","install":"^0.13.0","lodash.startcase":"^4.4.0","meow":"^9.0.0","npm":"^8.1.2","transform-markdown-links":"^2.0.0"},"gitHead":"79665179fee3427add769f45d53b755612643026","_id":"@aaronhuggins/concat-md@0.3.9","_nodeVersion":"14.17.3","_npmVersion":"6.14.13","dist":{"integrity":"sha512-vrPm+/xg+1a6hjeGGwF7qCEb+T8LlM5e3TDiLNEB18PttKkuOeVUgRgDjOi3fMVRtR94+7RfdVSdr5W3v9jZlA==","shasum":"96819a32f7a3154e22f6ab9a3301250500c7ca1a","tarball":"https://registry.npmjs.org/@aaronhuggins/concat-md/-/concat-md-0.3.9.tgz","fileCount":9,"unpackedSize":39500,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhuxr/CRA9TVsSAnZWagAA0EwP/3srJKGK0DtOB3aKELpt\nHkmfB8p5iEDxm9UrG4bAm5o/A7R10K3h4Q7RYBKDR7jlX+RwizwWntp+o0LA\nk9KU2186WY6P7nAYYuAUbUkFrZXloWJoPvxJC188u3Di2qRwS4c1O6it0iCO\nyaotPxTwi0S2VnuCVzy93PmAonJgdii7WJpPK19dVlW9AU/sObQthLX8j5ZF\n5oWKnNyWHW4rsheY0t3I3KkQBkS8Qe9SwNy2KbDmw4cHki4XEy3UV0khS7yU\nHB14uWSpdAozwanVFQYHp2kJEqUK+n+StxcVB+482/yjYQhpy2NEcHurV3CD\nuj2lWViKTy6I72npZh9HmIl/NI1jCtE9llTRoha4SQWWkz+imR/ZreDrKuOb\n0t7M67LRz7J/m4C9NHUaWWzSWsBlKYMdegZUMpYB4tuOcxRKq947S5ItpWvH\nA2prda17mAT+1sQ1Ltu/WRRAt/1+DxvCid4r9G6MMPQhf10ciwzMc8WMvaU5\nc58+haQ8rXYCQoTpULXvno6x4fO6qVRQRIvH7CgjeyolsVYN7e3gSRcvVnF2\nS3hkzTFy0lRaz4CZPmznNLeSdwVh90/Jro+doPPL+MxEF5evpqWXLNvq8/iY\nmyFz3xS9sQpomKXXzpsjSf7KSMcGX5LWRWE6CVAW9krH2JdK04GVjANEO/JF\nkhrF\r\n=pgfO\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCBjExa4pWq6ZeD+w7lp6c0OnCGr3SSLdApdiUCqUPS7QIhAKh4KKZq+gCaOMJyJQ1U2Xf+GArozupxuP+jO2NktM8c"}]},"_npmUser":{"name":"aaron.nuclearfamily","email":"aaron@nuclearfamily.llc"},"directories":{},"maintainers":[{"name":"aaron.nuclearfamily","email":"aaron@nuclearfamily.llc"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/concat-md_0.3.9_1635865012847_0.9784934992142715"},"_hasShrinkwrap":false}},"time":{"created":"2021-11-01T19:25:09.858Z","0.3.6":"2021-11-01T19:25:10.046Z","modified":"2022-04-04T10:55:41.152Z","0.3.7":"2021-11-01T19:31:25.472Z","0.3.8":"2021-11-02T14:54:15.675Z","0.3.9":"2021-11-02T14:56:53.034Z"},"maintainers":[{"name":"aaron.nuclearfamily","email":"aaron@nuclearfamily.llc"}],"description":"CLI and API to concatenate markdown files and modify as necessary.","homepage":"https://github.com/aaronhuggins/concat-md#readme","keywords":["concat","concatenate","merge","join","markdown","md","generator","creator","README","README.md","TypeDoc","JSDoc","FrontMatter","Meta","cms"],"repository":{"type":"git","url":"git+https://github.com/aaronhuggins/concat-md.git"},"author":{"name":"Özüm Eldoğan"},"bugs":{"url":"https://github.com/aaronhuggins/concat-md/issues"},"license":"MIT","readme":"# concat-md\n\nCLI and API to concatenate markdown files and modify as necessary.\n\n# Install\n\n```\n$ npm install -g concat-md\n```\n\nor use it via `npx`:\n\n```\n$ npx concat-md docs\n```\n\n# Usage\n\n**If files have titles in markdown already:**\n\n```\n$ concat-md --toc --decrease-title-levels --dir-name-as-title typedoc-api-docs > README.md\n```\n\n**If files have titles in FrontMatter meta data:**\n\n```\n$ concat-md --toc --decrease-title-levels --title-key title --file-name-as-title --dir-name-as-title docs > README.md\n```\n\n**If files don't have titles:**\n\n```\n$ concat-md --toc --decrease-title-levels --file-name-as-title --dir-name-as-title docs > README.md\n```\n\n# Features\n\n- Scans all markdown files in a directory,\n- Optionally ignores some files,\n- Concatenates all of them,\n- Adds table of contents,\n- Optionally adds titles from `FrontMatter`, file names and directory names,\n- Decreases level of existing titles to comply with added titles,\n- Adds anchor tags (`<a name=\"\"></a>`) to files, if no optional titles are generated.\n- Converts relative links to point to concatenated file,\n- Works async (default) and sync.\n\n# CLI Options\n\n```bash\nUsage\n  $ concat-md [options] <dir>\n\nOptions\n  --ignore <globs csv>              - Glob patterns to exclude in 'dir'.\n  --toc                             - Adds table of the contents at the beginning of file.\n  --decrease-title-levels           - Whether to decrease levels of all titles in markdown file to set them below file and directory title levels.\n  --start-title-level-at <level no> - Level to start file and directory levels. Default: 1\n  --join-string <string>            - String to be used to join concatenated files. Default: new line\n  --title-key <key name>            - Key name to get title in 'FrontMatter' meta data in markdown headers.\n  --file-name-as-title              - Whether to use file names as titles.\n  --dir-name-as-title               - Whether to use directory names as titles.\n  --debug                           - Print stack trace in errors.\n\nExamples\n  If files have titles in markdown already:\n    $ npx concat-md --toc --decrease-title-levels --dir-name-as-title typedoc-api-docs > README.md\n\n  If files have titles in FrontMatter meta data:\n    $ npx concat-md --toc --decrease-title-levels --title-key title --file-name-as-title --dir-name-as-title docs > README.md\n\n  If files don't have titles:\n    $ npx concat-md --toc --decrease-title-levels --file-name-as-title --dir-name-as-title docs > README.md\n```\n\n# Example\n\n```\n└─ Development\n   └─ Projects\n      └─ project-a\n         ├─ docs\n         ├─ classes\n         │  ├─ widget.md\n         │  ├─ utility.md\n         └─ interfaces\n            └─ screen.md\n```\n\n**classes/widget.md**\n\n```md\n# Description\n\nWidget details lorem ipsum...\n```\n\n**classes/utility.md**\n\n```md\n# Description\n\nUtility details lorem ipsum...\n```\n\n**interfaces/screen.md**\n\n```md\n# Description\n\nScreen details lorem ipsum...\n```\n\n```bash\n$ md-merge --decrease-title-levels --file-name-as-title --dir-name-as-title docs > README.md\n```\n\nAbove command;\n\n- Concatenates markdown files,\n- Adds directory names and file names as title,\n- Decreases level of `Description` titles,\n- Outputs to `README.md` as below:\n\n**README.md**\n\n```md\n# Classes\n\n## Widget\n\n### Description\n\nWidget details lorem ipsum...\n\n## Utility\n\n### Description\n\nUtility details lorem ipsum...\n\n# Interfaces\n\n## Screen\n\n### Description\n\nScreen details lorem ipsum...\n```\n\n# API\n\n<a name=\"readmemd\"></a>\n\n> **[concat-md](#readmemd)**\n\n### Index\n\n#### Interfaces\n\n- [ConcatOptions](#interfacesconcatoptionsmd)\n\n#### Functions\n\n- [concatMd](#concatmd)\n- [concatMdSync](#concatmdsync)\n\n## Functions\n\n### concatMd\n\n▸ **concatMd**(`dir`: string, `options?`: [ConcatOptions](#interfacesconcatoptionsmd)): _`Promise<string>`_\n\n_Defined in [index.ts:295](https://github.com/ozum/concat-md/blob/670ea75/src/index.ts#L295)_\n\nScans and concatenates all markdown files in given directory.\n\n#### Example\n\n```typescript\nimport concatMd, { concatMdSync } from \"concat-md\";\n```\n\n**Parameters:**\n\n| Name       | Type                                        | Description                                               |\n| ---------- | ------------------------------------------- | --------------------------------------------------------- |\n| `dir`      | string                                      | is the directory to scan markdown files in.               |\n| `options?` | [ConcatOptions](#interfacesconcatoptionsmd) | are several parameters to modify concatenation behaviour. |\n\n**Returns:** _`Promise<string>`_\n\nconcatenated contents of markdown files.\n\n---\n\n### concatMdSync\n\n▸ **concatMdSync**(`dir`: string, `options?`: [ConcatOptions](#interfacesconcatoptionsmd)): _string_\n\n_Defined in [index.ts:281](https://github.com/ozum/concat-md/blob/670ea75/src/index.ts#L281)_\n\nScans and concatenates all markdown files in given directory.\n\n#### Example\n\n```typescript\nimport concatMd, { concatMdSync } from \"concat-md\";\n```\n\n**Parameters:**\n\n| Name       | Type                                        | Description                                               |\n| ---------- | ------------------------------------------- | --------------------------------------------------------- |\n| `dir`      | string                                      | is the directory to scan markdown files in.               |\n| `options?` | [ConcatOptions](#interfacesconcatoptionsmd) | are several parameters to modify concatenation behaviour. |\n\n**Returns:** _string_\n\nconcatenated contents of markdown files.\n\n# Interfaces\n\n<a name=\"interfacesconcatoptionsmd\"></a>\n\n> **[concat-md](#readmemd)**\n\n[ConcatOptions](#interfacesconcatoptionsmd) /\n\n## Interface: ConcatOptions\n\nConcat function options.\n\n### Hierarchy\n\n- **ConcatOptions**\n\n#### Index\n\n##### Properties\n\n- [decreaseTitleLevels](#optional-decreasetitlelevels)\n- [dirNameAsTitle](#optional-dirnameastitle)\n- [fileNameAsTitle](#optional-filenameastitle)\n- [ignore](#optional-ignore)\n- [joinString](#optional-joinstring)\n- [startTitleLevelAt](#optional-starttitlelevelat)\n- [titleKey](#optional-titlekey)\n- [toc](#optional-toc)\n- [tocLevel](#optional-toclevel)\n\n### Properties\n\n#### `Optional` decreaseTitleLevels\n\n• **decreaseTitleLevels**? : _undefined | false | true_\n\n_Defined in [index.ts:52](https://github.com/ozum/concat-md/blob/670ea75/src/index.ts#L52)_\n\nWhether to decrease levels of all titles in markdown file to set them below file and directory title levels.\n\n---\n\n#### `Optional` dirNameAsTitle\n\n• **dirNameAsTitle**? : _undefined | false | true_\n\n_Defined in [index.ts:72](https://github.com/ozum/concat-md/blob/670ea75/src/index.ts#L72)_\n\nWhether to use directory names as titles.\n\n---\n\n#### `Optional` fileNameAsTitle\n\n• **fileNameAsTitle**? : _undefined | false | true_\n\n_Defined in [index.ts:68](https://github.com/ozum/concat-md/blob/670ea75/src/index.ts#L68)_\n\nWhether to use file names as titles.\n\n---\n\n#### `Optional` ignore\n\n• **ignore**? : _string | string[]_\n\n_Defined in [index.ts:48](https://github.com/ozum/concat-md/blob/670ea75/src/index.ts#L48)_\n\nGlob patterns to exclude in `dir`.\n\n---\n\n#### `Optional` joinString\n\n• **joinString**? : _undefined | string_\n\n_Defined in [index.ts:60](https://github.com/ozum/concat-md/blob/670ea75/src/index.ts#L60)_\n\nString to be used to join concatenated files.\n\n---\n\n#### `Optional` startTitleLevelAt\n\n• **startTitleLevelAt**? : _undefined | number_\n\n_Defined in [index.ts:56](https://github.com/ozum/concat-md/blob/670ea75/src/index.ts#L56)_\n\nLevel to start file and directory levels.\n\n---\n\n#### `Optional` titleKey\n\n• **titleKey**? : _undefined | string_\n\n_Defined in [index.ts:64](https://github.com/ozum/concat-md/blob/670ea75/src/index.ts#L64)_\n\nKey name to get title in `FrontMatter` meta data in markdown headers.\n\n---\n\n#### `Optional` toc\n\n• **toc**? : _undefined | false | true_\n\n_Defined in [index.ts:40](https://github.com/ozum/concat-md/blob/670ea75/src/index.ts#L40)_\n\nWhether to add a table of contents.\n\n---\n\n#### `Optional` tocLevel\n\n• **tocLevel**? : _undefined | number_\n\n_Defined in [index.ts:44](https://github.com/ozum/concat-md/blob/670ea75/src/index.ts#L44)_\n\nLimit TOC entries to headings only up to the specified level.\n","readmeFilename":"README.md"}