your content
\nFollow me on twitter!
\n```\n\n## Options\n\n```js\nvar md = require('markdown-it')()\n .use(require('markdown-it-include'), options);\n```\n\n* Options Type: `String|Object`\n\nIf it's a string, it's the same as `options.root`.\n\nOtherwise, it must be an options object (or `null` / `undefined` when you only wish to use the default options).\n\nThe options object may contain any of these:\n\n### root\n\n* Type: `String`\n* Default: `.`\n\n`root` is the base directory of all the markdown files.\n\n### get RootDir\n\n* Type: `Function`\n* Default: `(options, state, startLine, endLine) => options.root`\n\n`getRootDir()` can be used to customize the root directory used for the includes in a very flexible way.\n\nHere's an example where the root directory for the relative paths in the MarkDown is set to the directory the currently parsed MarkDown file is located in. Note that by setting this callback in the `state.env` state environment, we can have multiple different functions for multiple parse actions in parallel -- ahandy thing to have when we process the MarkDown content asynchronously, for example!\n\n```js\n// md instance setup:\nconst options = {\n root: '/bogus/',\n // show the\n getRootDir: (options, state, startLine, endLine) =>\n state.env.getIncludeRootDir(options, state, startLine, endLine),\n bracesAreOptional: true\n};\n\nlet md = require('markdown-it')()\n .use(require('markdown-it-include'), options);\n\n...\n\n// now in some async code rendering multiple MD files, we can do this:\n\n// (`mdPath` is an absolute path pointing to the MD file being processed)\nlet mdPath = ...;\n\nlet env = {};\nenv.getIncludeRootDir = function (options, state, startLine, endLine) {\n return path.dirname(mdPath);\n};\n\n// Use the 'unwrapped' version of the md.render / md.parse process:\n//\n// let content = md.render(data); --> .parse + .renderer.render\n//\n// .parse --> new state + process: return tokens\n// let tokens = md.parse(data, env)\nlet state = new md.core.State(data, md, env); // <-- here our env is injected into state!\nmd.core.process(state);\nlet tokens = state.tokens;\n// now call md.render():\nlet htmlContent = md.renderer.render(tokens, md.options, env);\n// presto! (End of `env` lifetime, BTW.)\n```\n\n### includeRe\n\n* Type: `RegExp`\n* Default: `/\\!{3}\\s*include(.+?)\\!{3}/i`\n\nBy default the `!!!include(path)!!!` statement is used to include markdown fragment files. This option allows to change the regular expression and then customize this statement.\n\n### bracesAreOptional\n\n* Type: `Boolean`\n* Default: `false`\n\nWhen set to TRUE, this option allows users to write include statements like `!!!include path !!!` instead of ``!!!include(path)!!!`. Note that when this option is set, both these forms are acceptable.\n\n> This allows you to configure the plugin to use C/C++ like `#include` statements in your MarkDown if you're so inclined -- I know I am! :)\n\nExample usage:\n\n```js\nconst options = {\n includeRe: /#include(.+)/,\n bracesAreOptional: true\n};\n\nlet md = require('markdown-it')()\n .use(require('markdown-it-include'), options);\nlet html = md.render('#include(xyz.md)\\n');\n```\n\n### throwError\n\n* Type: `Boolean`\n* Default: `true`\n\nWhen set to `false`, instead of throwing an error message, the error message will be written into the output. For references to possible error messages as well as how to change it, see options 'notFoundMessage' and 'circularMessage'.\n\nError messages will always be prefixed with the text `\"INCLUDE ERROR:\"` and will be rendered as `