Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate documentation to VitePress #115

Closed
ciscoo opened this issue Aug 2, 2024 · 3 comments
Closed

Migrate documentation to VitePress #115

ciscoo opened this issue Aug 2, 2024 · 3 comments
Labels
type: documentation A documentation update

Comments

@ciscoo
Copy link
Owner

ciscoo commented Aug 2, 2024

Various documentation tools were explored as part of #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 ciscoo added the type: documentation A documentation update label Aug 2, 2024
@ciscoo ciscoo added this to the 2.5.0 milestone Aug 2, 2024
@github-actions github-actions bot added the status: new An issue that has not been reviewed yet label Aug 2, 2024
@ajiho
Copy link

ajiho commented Aug 4, 2024

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

@ciscoo
Copy link
Owner Author

ciscoo commented Aug 4, 2024

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

@ciscoo ciscoo removed the status: new An issue that has not been reviewed yet label Aug 23, 2024
@ciscoo
Copy link
Owner Author

ciscoo commented Oct 2, 2024

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 ciscoo closed this as completed Oct 2, 2024
@ciscoo ciscoo removed this from the 2.5.0 milestone Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

2 participants