"#atomdoc-md\nMarkdown generator for [atomdoc](https://github.com/atom/atomdoc).\nUses [donna]() and [tello]().\n\nSee samples [here](https://github.com/venkatperi/atomdoc-md-samples).\n\n#Installation\nInstall with npm\n```\nnpm install -g atomdoc-md\n```\n\n#Examples\n## Generate docs\n```\natomdoc-md generate <path to module>\n```\n\n\n#Usage\n## Command Line\n\n```\natomdoc-md generate <module>\n\nOptions:\n  --doc, -o    docs directory  [default: \"doc\"]\n  --level, -l  log level  [choices: \"debug\", \"verbose\", \"info\", \"warn\", \"error\"] [default: \"info\"]\n  --template   template name  [default: \"api\"]\n  --meta       write donna (donna.json) and tello (tello.json) metadata to doc dir\n  --name, -n   generated file name  [default: \"api.md\"]\n```\n\n## From Node\n\n```coffeescript\nAtomdocMD = require 'atomdoc-md'\n\ngenerator = new AtomdocMD( options );\ngenerator.generateMarkdown()\n```\n\n## Generate `README.md`\n```\n# From the project's root\n\natomdoc-md generate -o . -n README.md .\n```\n\n## Importing Files\nThe default template `api` will include files `intro.md` and `appendix.md` into the output.\nThe files must be located in the `--doc` docs directory.\n\n\n\n# <a name='classes'>API</a>\n\nClass |  Summary\n------| ------------\n<code>[MarkdownGenerator](#class-MarkdownGenerator)</code> | Generates markdown from atomdoc/tello's metadata\n\n\n### <a name=\"class-MarkdownGenerator\">MarkdownGenerator</a><b><sub><sup><code>CLASS </code></sup></sub></b><a href=\"#classes\"><img src=\"https://rawgit.com/venkatperi/atomdoc-md/master/assets/octicons/arrow-up.svg\" alt=\"Back to Class List\" height= \"18px\"></a>\n\n<p>Generates markdown from atomdoc/tello&#39;s metadata</p>\n\n\n<table width=\"100%\">\n  <tr>\n    <td colspan=\"4\"><h4>Methods</h4></td>\n  </tr>\n  \n  <tr>\n    <td><code>:: <b>constructor(</b> options <b>)</b></code></td>\n    <td width=\"8%\" align=\"center\"><sub>public</sub></td>\n    <td width=\"8%\" align=\"center\"><sub>instance</sub></td>\n    <td width=\"8%\" align=\"center\"><sub><a href=\"#class-MarkdownGenerator\">MarkdownGenerator</a></sub></td>\n  </tr>\n  <tr>\n    <td colspan=\"4\">\n      <ul>\n  <li><code>options</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\">Object</a><ul>\n  <li><code>options.api</code> is an <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\">Object</a> with <code>tello</code> api metadata.</li>\n  <li><code>options.path</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\">String</a> path to file with <code>tello</code> api info</li>\n  <li><code>options.docdir</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\">String</a> dir to write the output to. Also looks for files to import (e.g. <code>intro.md</code>).</li>\n  <li><code>options.template</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\">String</a> name of the template to use</li>\n  <li><code>options.templatePath</code> <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\">String</a> alternatively, path to template dir</li>\n  </ul>\n  </li>\n  </ul>\n  \n      <p>Create a new markdown generator</p>\n  \n      \n    </td>\n  </tr>\n  \n  <tr>\n    <td><code>:: <b>generateMarkdown(</b>  <b>)</b></code></td>\n    <td width=\"8%\" align=\"center\"><sub>public</sub></td>\n    <td width=\"8%\" align=\"center\"><sub>instance</sub></td>\n    <td width=\"8%\" align=\"center\"><sub><a href=\"#class-MarkdownGenerator\">MarkdownGenerator</a></sub></td>\n  </tr>\n  <tr>\n    <td colspan=\"4\">\n      \n      <p>Writes markdown to the output file. </p>\n  \n      <p>  <em>Returns</em></p>\n  <ul>\n  <li>Returns a <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise\">Promise</a> which resolves with the generated\n  <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\">String</a> when done.</li>\n  </ul>\n  \n    </td>\n  </tr>\n  \n</table>\n\n\n\n\n<br>\n<sub>Markdown generated by [atomdoc-md](https://github.com/venkatperi/atomdoc-md).</sub>\n"