Add markdown renderers and renderer factory #2152
Conversation
jdkoren
force-pushed
the
md_renderers
branch
from
74faac0 to
658f241
Compare
Only enough to mirror the few tests we have that exercise the existing renderers. In the future, we should have a more comprehensive suite that covers both html and md.
This avoids calling back to Category, which immediately calls the renderer again anyway, except that during a test the second call went to an html renderer because the packageGraph was holding a HtmlRendererFactory.
There was a problem hiding this comment.
It looks like this might be enough now to actually write out some files. Are there any screenshots or other bits that can give a signal as to the progress? Particularly, if you can provide sample pages for the templates impacted (class, callable) -- even if they're not perfect, it would help me get a better sense of where we're at.
| CategoryRenderer get categoryRenderer => CategoryRendererMd(); | ||
|
|
||
| // We render documentation as HTML for now. | ||
| // TODO(jdkoren): explore using documentation directly in the output file. |
There was a problem hiding this comment.
This will be a challenge, particularly when it comes to tools. I'm also curious as to whether tool execution works correctly end-to-end here.
There was a problem hiding this comment.
Indeed, @tool was one of the reasons I thought to leave documentation as html inside the markdown page. Same for @video.
We could in theory run the tools as they are and expect that whoever is running Dartdoc has taken the output format into account when they added the tools...
There was a problem hiding this comment.
Well... that's not completely unreasonable if we provide a way to tell the tool what sort of output to generate. Keeping things HTML for now though makes a lot of sense as if you want any sort of compatibility with what Flutter is doing we'll either have to extend those tools or make it safe for them to continue outputting HTML.
|
Index Apple class isGreaterThan method |
No description provided.