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

New lines from jsdoc are ignored in the output markdown #37

Open
antoinetissier opened this issue Feb 22, 2022 · 0 comments
Open

New lines from jsdoc are ignored in the output markdown #37

antoinetissier opened this issue Feb 22, 2022 · 0 comments

Comments

@antoinetissier
Copy link
Collaborator

The output markdown is a single line even though the jsdoc has multiple lines.
See this example, where:

interface Configuration {
 /**
  * Redux store enhancers, allowing extensions to hook into the module federated application's state management.
  *
  * It can be used by an extension to:
  * - inject its own state in the module federated application, so that the extension itself and other extensions can consume it
  * - react to actions dispatched by the host application or other extensions
  *
  * The store enhancers are composed, which allows to split state management on a per-extension basis.
  *
  * See {@link https://redux.js.org/usage/configuring-your-store#extending-redux-functionality}
  */
  storeEnhancers?: StoreEnhancer[]
}

becomes

|  storeEnhancers | StoreEnhancer\[\] | Redux store enhancers, allowing extensions to hook into the module federated application's state management.It can be used by an extension to: - inject its own state in the module federated application, so that the extension itself and other extensions can consume it - react to actions dispatched by the host application or other extensionsThe store enhancers are composed, which allows to split state management on a per-extension basis.See [https://redux.js.org/usage/configuring-your-store\#extending-redux-functionality](https://redux.js.org/usage/configuring-your-store#extending-redux-functionality) |

This is most likely related to #35

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants