Docs Template for Module Authors
Hey y'all π ,
I'm currently working on a nuxt 3 component library as a nuxt module.
When I started the project a year ago I created a documentation site for it by myself. While improving both in development and design I now think it definitely deserves a rework. And that's what I'm currently doing.
I'm restructuring my module and on that action I also want to rework the docs. Since most public nuxt modules have a similar appearance of their docs I would like to adapt this Template. And that's pretty much my question:
What Template do you use for nuxt modules docs? Whats the way to go here, the 'Nuxt-Standard'.
I found the following two templates already:
Docus: https://github.com/nuxt-themes/docus
Nuxt-UI-Pro/Docs: https://github.com/nuxt-ui-pro/docs
Docus seems to be fairly wide spread, but many new modules seem to use Nuxt-UI-Pro/Docs.
Which would be the way to go, or am I even missing some other solution?
Thanks in advance for any help provided! π
GitHub
GitHub - nuxt-themes/docus: Write beautiful documentations with Nux...
Write beautiful documentations with Nuxt and Markdown. - nuxt-themes/docus
GitHub
GitHub - nuxt-ui-pro/docs: A documentation template made with Nuxt ...
A documentation template made with Nuxt UI Pro. Contribute to nuxt-ui-pro/docs development by creating an account on GitHub.
3 Replies
docus is deprecated from what I recall and nuxt/ui(-pro) is the way to go π
thereβs some thread on one of the repos that provides an email i think for module authors to get a license key too
Oh awesome. Thanks for the clarification. I'll have a look for the email then. βπΌ
Nuxt studio is a great solution for this, using the nuxt ui docs template: https://nuxt.studio/themes/docs