Skip to content

Update the Markdown docs #38

@hegemonic

Description

@hegemonic

We need to update a few things in the Markdown docs:

  • As of 3.2, we use the marked parser rather than github-friendly-markdown. One result is that you can no longer autolink to GitHub repos.
  • We need to document the new markdown.excludeTags option in conf.json. (See markdown.js plugin should allow config to override defaultTags jsdoc#337.)
  • We need to document that the following tags (and their synonyms) are, by default, parsed as Markdown:
    • classdesc
    • description
    • exception
    • param
    • property
    • returns
    • see

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions