@@ -50,26 +50,53 @@ <h1 class='h1 h0-responsive mt4 mb0 regular'>All the Code</h1>
50
50
</ div >
51
51
</ div >
52
52
</ section >
53
- < hr class ='b2 border-blue '> </ hr >
53
+ < hr class ='b2 border-blue ' / >
54
54
< div >
55
55
< section class ='container px3 py3 ' id ='install '>
56
56
< 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
62
83
$ 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 () {
68
94
gulp.src('./index.js')
69
95
.pipe(documentation({ format: 'md' }))
70
96
.pipe(gulp.dest('md-documentation'));
71
97
});
72
98
</ code > </ pre >
99
+ </ div >
73
100
</ section >
74
101
</ div >
75
102
</ body >
0 commit comments