Skip to content

Commit 0145e3a

Browse files
author
David, Shim
committed
Edit markdown style
1 parent 950df81 commit 0145e3a

File tree

10 files changed

+23
-18
lines changed

10 files changed

+23
-18
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,12 @@ $ npm install
1313
$ grunt demo
1414
```
1515

16-
You can see any output related jsdoc process with a `--debug` flag.
17-
16+
2. You can see any output related jsdoc process with a `--debug` flag.
1817
```
1918
$ grunt demo --debug
2019
```
2120

22-
2. If you already have jsdoc system, you can use this project as jsdoc template.
21+
3. If you already have jsdoc system, you can use this project as jsdoc template.
2322
```
2423
$ jsdoc -t `project folder` -c `configuration file` `source files` `README.md file`
2524
```

demo/dist/Car.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ <h1 class="page-title" data-filename="Car.js.html">Source: Car.js</h1>
200200

201201

202202
<footer>
203-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Jan 12 2014 17:15:46 GMT+0900 (KST)
203+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Jan 12 2014 17:27:47 GMT+0900 (KST)
204204
</footer>
205205
</div>
206206
</div>

demo/dist/Child.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -944,7 +944,7 @@ <h4 class="name" id="testMethodInChild">
944944

945945

946946
<footer>
947-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Jan 12 2014 17:15:47 GMT+0900 (KST)
947+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Jan 12 2014 17:27:48 GMT+0900 (KST)
948948
</footer>
949949
</div>
950950
</div>

demo/dist/Child.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ <h1 class="page-title" data-filename="Child.js.html">Source: Child.js</h1>
200200

201201

202202
<footer>
203-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Jan 12 2014 17:15:46 GMT+0900 (KST)
203+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Jan 12 2014 17:27:47 GMT+0900 (KST)
204204
</footer>
205205
</div>
206206
</div>

demo/dist/Namespace.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ <h1 class="page-title" data-filename="Namespace.js.html">Source: Namespace.js</h
172172

173173

174174
<footer>
175-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Jan 12 2014 17:15:46 GMT+0900 (KST)
175+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Jan 12 2014 17:27:47 GMT+0900 (KST)
176176
</footer>
177177
</div>
178178
</div>

demo/dist/Parent.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -651,7 +651,7 @@ <h5>Returns:</h5>
651651

652652

653653
<footer>
654-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Jan 12 2014 17:15:47 GMT+0900 (KST)
654+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Jan 12 2014 17:27:48 GMT+0900 (KST)
655655
</footer>
656656
</div>
657657
</div>

demo/dist/Parent.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ <h1 class="page-title" data-filename="Parent.js.html">Source: Parent.js</h1>
196196

197197

198198
<footer>
199-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Jan 12 2014 17:15:46 GMT+0900 (KST)
199+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Jan 12 2014 17:27:47 GMT+0900 (KST)
200200
</footer>
201201
</div>
202202
</div>

demo/dist/index.html

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -174,17 +174,23 @@ <h3> </h3>
174174

175175
<section>
176176
<article class="readme"><h2>Jaguar.js template for JSDoc 3</h2>
177-
<p><a href="http://davidshimjs.github.io/jaguarjs/doc/">View Jaguar.js Documentations</a></p>
177+
<ul>
178+
<li><a href="http://davidshimjs.github.io/jaguarjs">Jaguar.js</a></li>
179+
<li><a href="http://davidshimjs.github.io/jaguarjs/doc">Jaguar.js Documentations</a></li>
180+
<li><a href="https://github.com/jsdoc3/jsdoc">JSDoc3</a></li>
181+
<li><a href="http://usejsdoc.org">JSDoc3 API Documentations</a></li>
182+
</ul>
178183
<h2>Usage</h2>
179184
<ol>
180-
<li>If you want to create documentations with sample files, you can use commands below.<pre><code>$ npm install
185+
<li><p>If you want to create documentations with sample files, you can use commands below.</p>
186+
<pre><code>$ npm install
181187
$ grunt demo</code></pre>
182188
</li>
183-
</ol>
184-
<p>You can see any output related jsdoc process with a <code>--debug</code> flag.</p>
189+
<li><p>You can see any output related jsdoc process with a <code>--debug</code> flag.</p>
185190
<pre><code>$ grunt demo --debug</code></pre>
186-
<ol>
187-
<li>If you already have jsdoc system, you can use this project as jsdoc template.<pre><code>$ jsdoc -t `project folder` -c `configuration file` `source files` `README.md file`</code></pre>
191+
</li>
192+
<li><p>If you already have jsdoc system, you can use this project as jsdoc template.</p>
193+
<pre><code>$ jsdoc -t `project folder` -c `configuration file` `source files` `README.md file`</code></pre>
188194
</li>
189195
</ol>
190196
<h2>conf.json</h2>
@@ -218,7 +224,7 @@ <h2>License</h2>
218224

219225

220226
<footer>
221-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Jan 12 2014 17:15:46 GMT+0900 (KST)
227+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Jan 12 2014 17:27:47 GMT+0900 (KST)
222228
</footer>
223229
</div>
224230
</div>

demo/dist/namespace.Car.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -469,7 +469,7 @@ <h4 class="name" id="event:testEvent">
469469

470470

471471
<footer>
472-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Jan 12 2014 17:15:47 GMT+0900 (KST)
472+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Jan 12 2014 17:27:48 GMT+0900 (KST)
473473
</footer>
474474
</div>
475475
</div>

demo/dist/namespace.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ <h3 class="subsection-title">Classes</h3>
237237

238238

239239
<footer>
240-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Jan 12 2014 17:15:47 GMT+0900 (KST)
240+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Jan 12 2014 17:27:48 GMT+0900 (KST)
241241
</footer>
242242
</div>
243243
</div>

0 commit comments

Comments
 (0)