Skip to content

Add support for jsdoc config file path inclusion in task config #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jan 3, 2013
Merged

Add support for jsdoc config file path inclusion in task config #8

merged 1 commit into from
Jan 3, 2013

Conversation

metmajer
Copy link
Contributor

@metmajer metmajer commented Jan 2, 2013

The following patch adds an additional, optional property config to the task config which allows the user to include a JSDoc config file path:

Example:

jsdoc: {
    compile: {
        config: "jsdoc.json",
        src: ["src/**/*.js"],
        dest: "docs/jsdoc"
    }
}

A JSDoc config file can be used to allow markdown in JSDoc tags, see the Use JSDoc: How To Use the Markdown Plugin page for more information.

Sample JSDoc Configuration

The sample is heavily based on jsdoc's conf.json.EXAMPLE and uses the GitHub Flavored Markdown parser plugin.

{
    "tags": {
        "allowUnknownTags": true
    },
    "source": {
        "includePattern": ".+\\.js(doc)?$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "plugins": ["plugins/markdown"],
    "markdown": {
        "parser": "gfm"
    },
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false
    },
    "jsVersion": 180
}

@krampstudio krampstudio merged commit b6622bd into krampstudio:master Jan 3, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@metmajer @krampstudio