Add grunt 'docs' task to build both guides and API docs

This commit is contained in:
Matt Colyer
2013-08-19 16:20:13 -07:00
parent 2fee0f1083
commit 588efa2e11
3 changed files with 17 additions and 1 deletions

1
.gitignore vendored
View File

@@ -8,3 +8,4 @@ npm-debug.log
/tags
/atom-shell/
docs/api
docs/guides

View File

@@ -119,16 +119,30 @@ module.exports = (grunt) ->
'themes/**/*.less'
]
markdown:
guides:
files: [
expand: true,
cwd: 'docs'
src: '**/*.md',
dest: 'docs/guides/',
ext: '.html'
]
markdownOptions:
gfm: true
grunt.loadNpmTasks('grunt-coffeelint')
grunt.loadNpmTasks('grunt-lesslint')
grunt.loadNpmTasks('grunt-cson')
grunt.loadNpmTasks('grunt-contrib-csslint')
grunt.loadNpmTasks('grunt-contrib-coffee')
grunt.loadNpmTasks('grunt-contrib-less')
grunt.loadNpmTasks('grunt-markdown')
grunt.loadTasks('tasks')
grunt.registerTask('compile', ['coffee', 'less', 'cson'])
grunt.registerTask('lint', ['coffeelint', 'csslint', 'lesslint'])
grunt.registerTask('ci', ['lint', 'partial-clean', 'update-atom-shell', 'build', 'set-development-version', 'test'])
grunt.registerTask('deploy', ['partial-clean', 'update-atom-shell', 'build', 'codesign'])
grunt.registerTask('docs', ['markdown:guides', 'build-docs'])
grunt.registerTask('default', ['update-atom-shell', 'build', 'set-development-version', 'install'])

View File

@@ -110,7 +110,8 @@
"jasmine-focused": "~0.7.0",
"walkdir": "0.0.7",
"ws": "0.4.27",
"js-yaml": "~2.1.0"
"js-yaml": "~2.1.0",
"grunt-markdown": "~0.4.0"
},
"private": true,
"scripts": {