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

docs: migrate to vitepress #2735

Closed

Conversation

LiamEderzeel
Copy link

πŸ”— Linked issue

#2692

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

I changed out Docus for Vitepress, so i18n had the same doc site as some other Nuxt modules for a more unified look. Resolves #2692.

I could use some guidance with implementing the deployment process. It's unclear to me how the current documentation is deployed. Vitepress provides a GitHub workflow example here.

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

Copy link

nuxt-studio bot commented Jan 26, 2024

βœ… Live Preview ready!

Name Edit Preview Latest Commit
i18n Edit on Studio β†—οΈŽ View Live Preview aaf8faa

@kazupon
Copy link
Collaborator

kazupon commented Jan 28, 2024

@LiamEderzeel
Thank you for your contribution !

As I also commented on #2692 (comment), Nuxt I18n is the Nuxt ecosystem. so, Nuxt I18n docs should be created with Nuxt ecosystem.
(I am the author of vue-i18n and I use vitepress as docs in vue-i18n. And I know it is great!)

I apologies that I have to close your PR.
Again, Thank you very much!

@kazupon kazupon closed this Jan 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Revamp the docs
2 participants