Skip to content
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.

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

@deprecated breaks output Markdown #1596

Open
ingun37 opened this issue May 19, 2023 · 0 comments
Open

@deprecated breaks output Markdown #1596

ingun37 opened this issue May 19, 2023 · 0 comments

Comments

@ingun37
Copy link

ingun37 commented May 19, 2023

When the input JSDoc includes @deprecated tag then line breaks are not working in output markdown.
If input source file is

export class Aaa {
  /**
   * @deprecated
   */
  aaaaa() {}
}

then it outputs

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->### Table of Contents*   [aaaaa][1]## aaaaa**Meta***   **deprecated**: This is deprecated.[1]: #aaaaa

without any new line.

On the other hand, if the input doesn't include @deprecated then it outputs normally.

  • What version of documentation.js are you using?:
    14.0.1
  • How are you running documentation.js (on the CLI, Node.js API, Grunt, other?):
    CLI.
npx documentation build -f md --markdown-toc-max-depth 2 --shallow aaa.ts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant