Comments (4)
if you set the README as the last item of the src
option, it should work. Let me know if runs correctly, so I'll update the plugin doc.
from grunt-jsdoc.
I just tested this and didn't work:
module.exports = function(grunt) {
// Project configuration.
grunt.initConfig({
jsdoc : {
dist : {
src : ['frontend/js/**/*.js', 'README.rd'],
dest : 'docs/frontend',
config : 'config/jsdoc.json',
}
}
});
// Register jsdoc as a grunt task
grunt.loadNpmTasks('grunt-jsdoc-plugin');
// Default task. Now, just type "grunt" in the terminal, & the tasks on 2nd param will run
grunt.registerTask('default', 'jsdoc');
};
Also tried putting it inside the src strong for the directory but that throws errors, like so:
src : ['frontend/js/*/.js README.rd'],
from grunt-jsdoc.
I've not yet tried but it may be jsdoc error because the jsdoc documentation says that only markdown readmes are supported.
But I'll also check if it's working with markdown
from grunt-jsdoc.
Oh, yeah, renaming to .md did the trick! Problem solved. Thanks krampstudio!
from grunt-jsdoc.
Related Issues (20)
- Package Deprecated HOT 1
- deprecated [email protected] HOT 1
- Task Events HOT 5
- No source files defined HOT 2
- Event on compilation error HOT 2
- Getting command line too long while running grunt jsdocs as i am having large set of file, i also checked #51,#59 but not able to resolved. HOT 8
- Destination path not working in Grunt HOT 2
- Not adding the README.md file (was working in old versions)
- JSDoc is now in version 3.4.1 which resolves the Github dependency HOT 4
- Include several md files
- Include symbols marked with @private with the "-p" cli argument HOT 3
- JSDoc dependency breaking build HOT 5
- Copying files broken by Node v8.5.0 HOT 2
- Upgrade to jsdoc 3.5.5 HOT 3
- transitive dependency is insecure HOT 1
- jsdoc not built HOT 7
- Help!!! Why I get syntaxError when run "grunt jsdoc" HOT 1
- Security warning on 'npm audit' due to old dependency marked HOT 1
- grunt-jsdoc duplicate all classes, but command line is Ok HOT 5
- Install not working since months HOT 8
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from grunt-jsdoc.