cxf-codegen-gradle icon indicating copy to clipboard operation
cxf-codegen-gradle copied to clipboard

Migrate documentation to VitePress

Open ciscoo opened this issue 1 year ago • 2 comments

Various documentation tools were explored as part of https://github.com/ciscoo/cxf-codegen-gradle/issues/97. The primary reason to migrate to VitePress is the minimal setup.

There is only a single file needed to get going: config.mts. Everything else is markdown content for documentation. Compared to Antora and Docusaurus where several files and configurations were required to get going.

ciscoo avatar Aug 02 '24 13:08 ciscoo

Yes, I also think Vitepress has a relatively clean configuration. As for version management, you can use Vercel or Netlify because these two tools produce a unique URL address every time it is deployed and it will never disappear

ajiho avatar Aug 04 '24 15:08 ajiho

Oh! I did not know that was possible. Thanks @ajiho !

ciscoo avatar Aug 04 '24 15:08 ciscoo

Changing course (again), plan is to continue to use Asciidoctor primarily because it provides a means to export documentation for offline usages which is important for countries where Internet access is a luxury. I have come across several Stack Overflow questions on offline documentation in the last few months which has influenced my decision.

VitePress does not have an official solution and instead delegates to third party/OSS projects. Asciidoctor on the other hand, provides first class support for exporting to PDF as well as EPUB3.

ciscoo avatar Oct 02 '24 01:10 ciscoo