search

mipatterson / typedoc-plugin-pages

A TypeDoc plugin that lets you integrate your own pages into the documentation output
Apache License 2.0
37 stars 21 forks source link

typedoc-plugin-pages : support of plantuml document #11

Open yboujraf opened 4 years ago

yboujraf commented 4 years ago

Dear @mipatterson

I am following your plugin and it seems answering my request.

PLANTUML RENDERING

I have external document in markdown where we have plantuml sequence diagram to document our project.

Do you think you will suport it. We already using plantuml plugin but don't now if we could use multiple plugin at same time to render the doc ?

Best Regards, Youssef

loopingz commented 3 years ago

I started working on this one: http://tplant.loopingz.com/ as I would also like to integrate it with my docs.

It is available on github.com/loopingz/tplantviewer

mipatterson commented 3 years ago

My concern here is that this plugin will never (and should never be expected to) perform every function that other plugins provide. It's just not sustainable. That being said, I do recognize that UML support seems to be popular among the users of TypeDoc.

Rather than implement this feature inside this plugin, I'm thinking it might be better to provide some sort of mechanism for third-party code to preprocess the Markdown that is rendered to pages. Though I'm hesitant to build a plugin framework for a plugin of a framework 😆.

I'm also wondering if the work I'm doing to support HTML pages might not be another avenue for achieving this in the short-term. This will allow you to include HTML-based pages in the build.

Let me give this some more thought. Perhaps there is a way to re-raise the TypeDoc events so that other plugins (like PlantUML plugins) would preprocess as normal without even knowing about this plugin...

loopingz commented 3 years ago

Yes, I do not think this stands in this plugin. The uml plugin should be a separate plugin that trigger a tplant export and reprocess it as other pages. That is why I started playing with how to display it

airtonix commented 3 years ago

just let people describe markdown plugins that already perform this function

loopingz commented 3 years ago

@airtonix not sure what you meant

airtonix commented 3 years ago

@loopingz it was a casual drive by comment at @mipatterson.

typedoc-plugin-pages should just expose a configuration option to control which marked plugins to use.