Skip to content

Commit fcb665f

Browse files
add an html docs front page
"welcome" fixes dc-js#1103
1 parent 1754a73 commit fcb665f

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

Gruntfile.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ module.exports = function (grunt) {
8484
},
8585
watch: {
8686
jsdoc2md: {
87-
files: ['<%= conf.src %>/**/*.js'],
87+
files: ['welcome.md', '<%= conf.src %>/**/*.js'],
8888
tasks: ['build', 'jsdoc', 'jsdoc2md']
8989
},
9090
scripts: {
@@ -216,7 +216,7 @@ module.exports = function (grunt) {
216216
},
217217
jsdoc: {
218218
dist: {
219-
src: ['<%= conf.src %>/**/*.js', '!<%= conf.src %>/{banner,footer}.js'],
219+
src: ['welcome.md', '<%= conf.src %>/**/*.js', '!<%= conf.src %>/{banner,footer}.js'],
220220
options: {
221221
destination: 'web/docs/html',
222222
template: 'node_modules/ink-docstrap/template',

welcome.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# dc.js
2+
3+
Welcome to the dc.js documentation.
4+
5+
The entire library is scoped under {@link dc the dc namespace}.
6+
7+
The other Namespaces contain utilities.
8+
9+
The charts are listed under Classes.
10+
11+
And shared chart functionality is under Mixins.

0 commit comments

Comments
 (0)