dartdoc icon indicating copy to clipboard operation
dartdoc copied to clipboard

Refactor dartdoc markdown extensions into an ExtensionSet

Open kevmoo opened this issue 8 years ago • 8 comments

Let's keep dartdoc and the pub site aligned here. No surprises or inconsistencies.

  • [ ] Autolink w/out http[s] is kinda nice, but it's not consistent with how docs are rendered on GitHub or the package site.

  • [ ] supporting [:...:] seems like a legacy holdover. We should remove these types of links from the SDK and then remove this, too.

kevmoo avatar Nov 02 '17 18:11 kevmoo

CC @devoncarew

kevmoo avatar Nov 02 '17 18:11 kevmoo

Where do we do the first one?

+1 to the 2nd item.

devoncarew avatar Nov 02 '17 18:11 devoncarew

What (?) do we do the first one?

Render out http and https – as is standard.

If folks want pretty links, they can use the other syntax. Not worth the inconsistency IMHO

kevmoo avatar Nov 02 '17 18:11 kevmoo

Ah, this was a flutter request - to display http://www.foo.bar as www.foo.bar and hyperlinked. It is prettier :)

devoncarew avatar Nov 02 '17 19:11 devoncarew

Then at a minimum, we should create our own ExtensionSet in the markdown package and standardize on it.

At least so we're all together on our exceptions....

kevmoo avatar Nov 02 '17 19:11 kevmoo

I like the idea generally, but remember Dartdoc will always have extensions that are specific to it. It would be helpful if markdown's ExtensionSet had a public constructor and you could do something like:

new ExtensionSet.from(ExtensionSet.gitHub, inline: [new MoreStuff()], block: [new MoreStuffBlock()])

This would enable us to have a common base and add to it.

jcollins-g avatar Dec 05 '17 17:12 jcollins-g

Open that issue!

On Tue, Dec 5, 2017 at 9:26 AM, jcollins-g [email protected] wrote:

I like the idea generally, but remember Dartdoc will always have extensions that are specific to it. It would be helpful if markdown's ExtensionSet had a public constructor and you could do something like:

new ExtensionSet.from(ExtensionSet.gitHub, inline: [new MoreStuff()], block: [new MoreStuffBlock()])

This would enable us to have a common base and add to it.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/dart-lang/dartdoc/issues/1534#issuecomment-349377633, or mute the thread https://github.com/notifications/unsubscribe-auth/AABCigS1wSQx-WR5i-xAf5GY0j0HsQqcks5s9XzYgaJpZM4QQLu1 .

kevmoo avatar Dec 05 '17 17:12 kevmoo

dart-lang/tools#1388

jcollins-g avatar Dec 05 '17 18:12 jcollins-g