Skip to content

Commit fab2140

Browse files
committed
Dev-documentation shoutout
1 parent c8dfc1f commit fab2140

File tree

1 file changed

+38
-11
lines changed

1 file changed

+38
-11
lines changed

index.html

Lines changed: 38 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -50,26 +50,53 @@ <h1 class='h1 h0-responsive mt4 mb0 regular'>All the Code</h1>
5050
</div>
5151
</div>
5252
</section>
53-
<hr class='b2 border-blue'></hr>
53+
<hr class='b2 border-blue' />
5454
<div>
5555
<section class='container px3 py3' id='install'>
5656
<h1 class='h1 h0-responsive mt1'>Use It</h1>
57-
<h2 class='h2'>Node.js</h2>
58-
<h4 class='h4'>Install</h4>
59-
<pre class='bg-darken-1 px1 py2'>$ npm install -g documentation</pre>
60-
<h4 class='h4'>Usage</h4>
61-
<pre class='bg-darken-1 px1 py2'>$ documentation --help
57+
<div class='py2'>
58+
<h2 class='h2'>Writing Documentation</h2>
59+
<div class='clearfix mxn2'>
60+
<div class='sm-col-6 sm-col px2'>
61+
<p class='py2'>Documentation has a first-class environment for <em>writing new documentation</em>,
62+
so that you can live-preview generated documentation as you edit
63+
the code's JSDoc comments. This is called <a href='https://github.com/documentationjs/dev-documentation'>dev-docmentation</a>.
64+
To install it, you'll need <a href='https://nodejs.org/'>node.js</a>.</p>
65+
<pre class='bg-darken-1 px1 py2'>$ npm install -g dev-documentation</pre>
66+
<p>Then just run the command <code>dev-documentation</code> with no arguments to
67+
document everything in the current directory, or with a specific filename
68+
to document just one file.</p>
69+
<pre class='bg-darken-1 px1 py2'>$ cd my-project
70+
$ dev-documentation</pre>
71+
</div>
72+
<div class='sm-col-6 sm-col'>
73+
<img src='http://i.imgur.com/I0VFaha.gif' title='Demo of dev-documentation' />
74+
</div>
75+
</div>
76+
</div>
77+
<div class='py2'>
78+
<h2 class='h2'>Node.js</h2>
79+
<h4 class='h4'>Install</h4>
80+
<pre class='bg-darken-1 px1 py2'>$ npm install -g documentation</pre>
81+
<h4 class='h4'>Usage</h4>
82+
<pre class='bg-darken-1 px1 py2'>$ documentation --help
6283
$ documentation file.js -f md > API.md</pre>
63-
<h2 class='h2'>Gulp</h2>
64-
<h4 class='h4'>Install</h4>
65-
<pre class='bg-darken-1 px1 py2'>$ npm install gulp-documentation</pre>
66-
<h4>In your gulpfile</h4>
67-
<pre><code class='js'>gulp.task('documentation', function () {
84+
<p>The documentation module also has a great <a href='https://github.com/documentationjs/documentation'>node-facing API</a>.<p>
85+
</div>
86+
<div class='py2'>
87+
<h2 class='h2'>Gulp</h2>
88+
<h4 class='h4'>Install</h4>
89+
<pre class='bg-darken-1 px1 py2'>$ npm install gulp-documentation</pre>
90+
<h4>In your gulpfile</h4>
91+
<pre><code class='js'>var gulp = require('gulp');
92+
var documentation = require('gulp-documentation');
93+
gulp.task('documentation', function () {
6894
gulp.src('./index.js')
6995
.pipe(documentation({ format: 'md' }))
7096
.pipe(gulp.dest('md-documentation'));
7197
});
7298
</code></pre>
99+
</div>
73100
</section>
74101
</div>
75102
</body>

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy