-
Notifications
You must be signed in to change notification settings - Fork 10
/
index.html
147 lines (143 loc) · 4.98 KB
/
index.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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset='utf-8'>
<title>documentation.js</title>
<meta title='description' content='a documentation system so good, you'll actually write documentation'>
<meta name='viewport' content='width=device-width,initial-scale=1'>
<link rel='stylesheet' href='assets/basscss.css' />
<link rel='stylesheet' href='assets/color-brewer.css' />
<link rel='canonical' href='https://documentation.js.org/'>
<script src='assets/highlight.pack.js'></script>
<script>hljs.initHighlightingOnLoad();</script>
<style>
body {
font-family: Georgia, Times New Roman, serif;
font-size:18px;
}
.bg-lightblue {
background-color: #E4F1FE
}
.py8 { padding-top: 8rem; padding-bottom: 8rem }
</style>
</head>
<body>
<nav class='clearfix bg-lightblue py2 px2 right'>
<span style='position:relative;top:8px;'>
<iframe src='https://ghbtns.com/github-btn.html?user=documentationjs&repo=documentation&type=star&count=true&size=large' frameborder='0' scrolling='0' width='160px' height='30px'></iframe>
</span>
<a class='px2 h3' href='https://github.com/documentationjs/documentation/blob/master/docs/GETTING_STARTED.md' class='button py2 button-transparent'>Guide</a>
<a class='px2 h3' href='https://github.com/documentationjs/documentation' class='button py2 button-transparent'>GitHub</a>
</nav>
<header class='center px3 py8 bg-lightblue bg-cover bg-center border-bottom'>
<img style='max-width:672px;width:100%;' src='documentationjs@2x.png' alt="documentation.js" />
<p class='italic'>a documentation system so good, you'll actually write documentation</p>
</header>
<section class='container'>
<div class='px2 mt4 clearfix mxn2'>
<div class='sm-col sm-col-4 px2'>
<img src='illustrations/output.jpg' />
</div>
<div class='sm-col sm-col-8 px2'>
<div class='h2 mb0 mt2'>
<span class='caps bold'>
Output
</span>
<span>
HTML +
Markdown +
JSON
</span>
</div>
<p class='mt2'>
documentation.js has pluggable output formats: you can get raw
documentation as JSON, beautiful, customizable HTML, or Markdown
that fits perfectly into an API.md or README.md file in a GitHub
repository
</p>
<p>
<div>
Demos:
self-documentation as
<a href='http://documentation.js.org/html-example/'>HTML</a>,
<a href='https://github.com/documentationjs/documentation/blob/master/docs/NODE_API.md'>Markdown</a>,
<a href='http://documentation.js.org/html-example/index.json'>JSON</a>
</div>
<div>
In production: <a href='https://www.mapbox.com/mapbox-gl-js/api/'>Mapbox GL JS API</a>
</div>
</p>
</div>
</div>
<div class='px2 mt4 clearfix mxn2'>
<div class='sm-col sm-col-4 px2'>
<img src='illustrations/universal.jpg' />
</div>
<div class='sm-col sm-col-8 px2'>
<div class='h2 mb0 mt1'>
<span class='caps bold'>
Universal
</span>
<span>
JavaScript +
ES6 Syntax +
CommonJS
</span>
</div>
<p class='py2'>
documentation.js aims to cover all flavors of modern JavaScript.
</p>
</div>
</div>
<div class='px2 mt4 clearfix mxn2'>
<div class='sm-col sm-col-4 px2'>
<img src='illustrations/integrated.jpg' />
</div>
<div class='sm-col sm-col-8 px2'>
<div class='h2 mb0'>
<span class='caps bold'>
Integrated
</span>
<span>
<a href='https://github.com/documentationjs/documentation#user-guide'>CLI</a>
+ Node.js</li>
+ <a href='https://github.com/documentationjs/gulp-documentation'>Gulp</a>
+ <a href='https://github.com/documentationjs/grunt-documentation'>Grunt</a>
</span>
</div>
<p class='py2'>
documentation.js works in your workflow, whether you just want a command-line
utility that generates documentation from your code,
you use Gulp to publish websites, or you're building
a new system and want low-level JavaScript methods.
</p>
</div>
</div>
</section>
<div class='bg-lightblue py2 px2 border-top mt4'>
<section class='container'>
<div class='px2 mb4'>
<div class='h2 mt4 mb0'>
<span class='caps bold'>
Get started
</span>
</div>
<p class='py2'>
<a
class='btn btn-primary mb1 mt1 bg-navy white'
href='https://github.com/documentationjs/documentation/blob/master/docs/GETTING_STARTED.md'>
Start using documentation.js to write documentation.
</a>
</p>
</div>
</section>
<section class='container center muted'>
<a href='https://github.com/documentationjs/documentation'>
<img style='vertical-align:middle;max-width:168px;width:100%;' src='documentationjs@2x.png' />
</a>
created by <a href='https://github.com/documentationjs/documentation/graphs/contributors'>wonderful people</a>,
distributed under the <a href='https://github.com/documentationjs/documentation/blob/master/LICENSE'>ISC license</a>.
</section>
</div>
</body>
</html>