about-including-readme.html

<!DOCTYPE html>
<!-- THIS IS A GENERATED FILE. DO NOT EDIT. -->
<html lang="en">

<head>
  <meta charset="utf-8">
  <meta name="description" content="A guide to including a readme file in your documentation.">
  <title>Use JSDoc: Including a Readme File With JSDoc 3</title>
  <link rel="stylesheet" href="styles/usejsdoc.css">
  <link rel="stylesheet" href="styles/prettify.css">
  <link rel="stylesheet" href="styles/css3-github-ribbon.css">
  <script src="scripts/prettify.js"></script>
  <!--[if lt IE 9]>
            <script src="scripts/html5shiv.min.js"></script>
            <script src="scripts/html5shiv-printshiv.min.js"></script>
        <![endif]-->
</head>

<body>
  <header>
    <a href="./index.html">@use JSDoc</a>
  </header>
  <article>
    <h1>Including a Readme File With JSDoc 3</h1>
    <p>To include a readme file in your documentation, you simply specify the location of your readme file on the command line along with the location of your source
      files. The readme file will be incorporated into the index.html of your documentation in the default template. The file must be written in markdown and given
      a .md extension.</p>
    <figure>
      <figcaption>Including a readme file in your documentation</figcaption><pre class="prettyprint"><code>jsdoc C:\path\to\my\JS\project\sourceFiles C:\path\to\my\JS\project\README.md
</code></pre>
    </figure>
    <p>If your file is successfully incorporated into the default template, it&#39;s content will be rendered in beautiful HTML just before the files list.</p>
  </article>
  <footer>
    <a class="license-badge" href="http://creativecommons.org/licenses/by-sa/3.0/">
      <img alt="Creative Commons License" class="license-badge" src="images/cc-by-sa.svg" width="80" height="15" />
    </a>
    <br> Copyright &#169; 2011-2014 the
    <a href="https://github.com/jsdoc3/jsdoc3.github.com/contributors">contributors</a> to the JSDoc 3 documentation project.
    <br> This website is <a href="https://github.com/jsdoc3/jsdoc3.github.com">open source</a> and is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">
        Creative Commons Attribution-ShareAlike 3.0 Unported License</a>.
  </footer>
  <script type="text/javascript">
    prettyPrint();
  </script>
</body>

</html>