Skip to content

Support for Dartdoc > Markdown Tables? #2559

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

Closed
ened opened this issue Jun 16, 2020 · 2 comments
Closed

Support for Dartdoc > Markdown Tables? #2559

ened opened this issue Jun 16, 2020 · 2 comments

Comments

@ened
Copy link
Contributor

ened commented Jun 16, 2020

Is it possible to show markdown tables in the doc previews?

It seems the feature is generally available in dartdoc dart-lang/dartdoc#1453, yet when I tried to add code like this:

  /// Return values:
  /// 
  /// | Component | Symbol | Short Form   | Long Form         | Numeric   | 2-digit   |
  /// |-----------|:------:|--------------|-------------------|-----------|-----------|
  /// | era       |   G    | G (AD)       | GGGG (Anno Domini)| -         | -         |
  /// | year      |   y    | -            | -                 | y (2015)  | yy (15)   |
  /// 
  /// 

The area for the return values table stays empty, once hovering the relevant function.

@DanTup
Copy link
Member

DanTup commented Jun 16, 2020

Markdown rendering is done by VS Code. It seems like this was supported, but was recently broken:

microsoft/vscode#99983

It's been fixed in the last few days and I can see the fix works in the Insiders version:

Screenshot 2020-06-16 at 14 49 51

So this should be fixed with the next release of VS Code.

Thanks!

@ened
Copy link
Contributor Author

ened commented Jun 16, 2020

@DanTup Thank you very much.

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