Skip to content

Support tables in dartdoc #1557

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

Merged
merged 6 commits into from
Dec 5, 2017
Merged

Conversation

jcollins-g
Copy link
Contributor

Fixes #1453. Dartdoc now supports more of GFM, including tables.

screenshot from 2017-12-04 11 28 59

@googlebot googlebot added the cla: yes Google CLA check succeeded. label Dec 4, 2017
@@ -145,7 +145,10 @@ final HtmlEscape htmlEscape = const HtmlEscape(HtmlEscapeMode.ELEMENT);
final List<md.InlineSyntax> _markdown_syntaxes = [
new _InlineCodeSyntax(),
new _AutolinkWithoutScheme()
];
]..addAll(md.ExtensionSet.gitHub.inlineSyntaxes);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See https://github.com/dart-lang/pub-dartlang-dart/blob/master/app/lib/shared/markdown.dart#L11

Not sure exactly what to do here. Ideally we'd all agree on how markdown is rendered.

https://github.com/dart-lang/pub-dartlang-dart/blob/8ae285f2b846b0e3bf1098162318f6c52eff5776/app/lib/shared/markdown.dart#L11

I've tried to move the markdown package towards GFM standard. But that doesn't include header links.

Just FYI that we've diverged here...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I filed a bug related to this yesterday because markdown's README claims it does have header links for its github extension set: https://github.com/dart-lang/markdown/issues/185.

Dartdoc is always going to have at least a bit of customization, but hopefully we can get it to a point where it is purely additive..

Copy link
Member

@devoncarew devoncarew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 awesome!

@jcollins-g jcollins-g merged commit cc9b95a into master Dec 5, 2017
@mit-mit
Copy link
Member

mit-mit commented Dec 5, 2017

Very cool!!! @jcollins-g what needed to get this reflected on existing documentation, for example https://www.dartdocs.org/documentation/url_launcher/1.0.3/index.html ?

@jcollins-g
Copy link
Contributor Author

jcollins-g commented Dec 5, 2017

A release needs to happen (#1559) and someone will have to do whatever dartdocs.org does to generate docs with the new version.

@kevmoo kevmoo deleted the fix-generic-types-constructors+markdown branch December 5, 2017 19:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Google CLA check succeeded.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants