-
Notifications
You must be signed in to change notification settings - Fork 105
/
Copy pathabout-including-readme.html
65 lines (62 loc) · 2.9 KB
/
about-including-readme.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
<!DOCTYPE html>
<!-- THIS IS A GENERATED FILE. DO NOT EDIT. -->
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="description" content="How to include a README file in your documentation.">
<title>Use JSDoc: Including a README File</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>
</head>
<body>
<header>
<a href="./index.html">@use JSDoc</a>
</header>
<article>
<h1>Including a README File</h1>
<p>There are two ways to incorporate a <code>README</code> file into your documentation:</p>
<ol>
<li>In the source paths to your JavaScript files, include the path to a Markdown file named
<code>README.md</code>. JSDoc will use the first <code>README.md</code> file that it finds in your source paths.</li>
<li>Run JSDoc with the <code>-R/--readme</code> command-line option, specifying the path to your <code>README</code> file.
This option is available in JSDoc 3.3.0 and later. The <code>README</code> file may have any name and
extension, but it must be in Markdown format.</li>
</ol>
<p>The <code>-R/--readme</code> command-line option takes precedence over your source paths. If you use the
<code>-R/--readme</code> command-line option, JSDoc will ignore any <code>README.md</code> files in your source paths.</p>
<p>If you are using JSDoc's default template, the <code>README</code> file's contents will be rendered in HTML
in the generated documentation's <code>index.html</code> file.</p>
<h2 id="examples">Examples</h2>
<figure>
<figcaption>Including a README file in your source paths</figcaption>
<pre class="prettyprint"><code>jsdoc path/to/js path/to/readme/README.md
</code></pre>
</figure>
<figure>
<figcaption>Using the -R/--readme option</figcaption>
<pre class="prettyprint"><code>jsdoc --readme path/to/readme/README path/to/js
</code></pre>
</figure>
</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 © 2011-2019 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>
<p>
<a href="https://github.com/jsdoc3/jsdoc" class="github-ribbon">Fork me on GitHub</a>
</p>
<script type="text/javascript">
prettyPrint();
</script>
</body>
</html>