Documentation options

[Naresh Bhatia]

Hi,

I wanted to find out what documentation options are available with StarUML. I would like to write documentation that includes StarUML diagrams + rich text + external graphics.

1. One option is the markdown extension but the install button on it is disabled in the extension manager. Also the link https://github.com/staruml/staruml-markdown gives a 404.
2. Another option is to write documentation in Google Docs and embed StarUML diagrams in it. However the issue with this approach is that when diagrams are updated in StartUML, Google Docs will not get the updates. Has anyone found a good workflow for this. I don't mind using other tools like Confluence, but the requirement is that diagrams should update automatically.

Thanks in advance for your help. 

[StarUML]

Hello,

1. Markdown extensions are already included by default. (Tools > Markdown Documentation)

2. The desktop application is unlikely to meet your needs. There is a way to automatically generate documents from .mdj files. You'll need to develop it yourself using the CLI or the Extension API. (See https://docs.staruml.io/). 

Thanks,

2024년 4월 13일 토요일 오후 11시 23분 29초 UTC+9에 m...@nareshbhatia.dev님이 작성:

[Naresh Bhatia]

I don't see Tools > Markdown Documentation

[StarUML]

Sorry, View > Markdown Documentation.

Thanks,

2024년 4월 15일 월요일 오후 10시 24분 12초 UTC+9에 m...@nareshbhatia.dev님이 작성:

[Naresh Bhatia]

Got it! Thank you.