nuxt-themes / docus

Write beautiful documentations with Nuxt and Markdown.
https://docus.dev
MIT License
1.51k stars 157 forks source link

chore: update current docus deployments #303

Open pi0 opened 3 years ago

pi0 commented 3 years ago

This is a list to keep an eye on projects currently use Docus (feel free to edit message):

Repo URL Tree Docus version PR Open
nuxt/http https://http.nuxtjs.org/ https://github.com/nuxt/http/tree/master/docs ^1.1.3
nuxt/image https://image.nuxtjs.org/ https://github.com/nuxt/image/tree/main/docs ^1.1.3
nuxt/content https://content.nuxtjs.org/ https://github.com/nuxt/content/tree/main/docs ^1.1.3
nuxt-modules/i18n https://i18n.nuxtjs.org/ https://github.com/nuxt-modules/i18n/tree/master/docs ^1.1.3
nuxt-modules/apollo https://apollo.nuxtjs.org/ https://github.com/nuxt-modules/apollo/tree/master/docs ^1.1.3
nuxt-modules/tailwindcss https://tailwindcss.nuxtjs.org/ https://github.com/nuxt-modules/tailwindcss/tree/main/docs ^1.1.3
nuxt-modules/sanity https://sanity.nuxtjs.org/ https://github.com/nuxt-modules/sanity ^1.1.3
nuxt-modules/strapi https://strapi.nuxtjs.org/ https://github.com/nuxt-modules/strapi ^1.1.3
nuxt-modules/color-mode  https://color-mode.nuxtjs.org/ https://github.com/nuxt-community/color-mode-module ^1.1.3
nuxt-community/ackee-module https://ackee.nuxtjs.org https://github.com/nuxt-community/ackee-module ^1.1.3
unjs/nitro https://nitro.unjs.io https://github.com/unjs/nitro ^1.1.3
nuxt-community/strapi-module https://strapi.nuxtjs.org/ https://github.com/nuxt-community/strapi-module ^0.5.14
nuxt-community/composition-api https://composition-api.nuxtjs.org/ https://github.com/nuxt-community/composition-api ^0.5.6
danielroe/typed-vuex https://typed-vuex.roe.dev/ https://github.com/danielroe/typed-vuex ^0.5.6
Tahul commented 3 years ago

Thank you a lot @pi0 🙏

Tahul commented 3 years ago

For @nuxt/image: https://github.com/nuxt/image/pull/282

For @nuxtjs/composition-api: https://github.com/nuxt-community/composition-api/pull/485

Tahul commented 3 years ago

For @nuxt/http: https://github.com/nuxt/http/pull/180

Tahul commented 3 years ago

For @nuxt/vite: https://github.com/nuxt/vite/pull/145

Tahul commented 3 years ago

For nuxt-community/tailwindcss-module: https://github.com/nuxt-community/tailwindcss-module/pull/352

Tahul commented 3 years ago

For nuxt-community/sanity-module: https://github.com/nuxt-community/sanity-module/pull/149

Tahul commented 3 years ago

For danielroe/typed-vuex: https://github.com/danielroe/typed-vuex/pull/235

Atinux commented 3 years ago

Updated to add nuxt-community/ackee-module

Tahul commented 3 years ago

Hey :wave:

Thanks @Atinux ;

I've also updated it to add nuxt-community/color-mode-module :smile:

Will be updating them once I'm done with the documentation update

Atinux commented 3 years ago

Added https://github.com/nuxt-community/strapi-module to the list, cc @benjamincanac he had an issue with it.

Atinux commented 1 year ago

We should track the update of Docus now for all of these websites.

Tahul commented 1 year ago

@Atinux ; can we add Docus to Vue Telescope somehow?

I would love to have a complete list so I can process all these updates in a batch.

Updating from latest Tailwind version to ^1.0.0 isstraightforward andrepetitive so I would like to process this all at once.

Tahul commented 1 year ago

cc: @Atinux @pi0 @danielroe ;

I suggest that we deprecate vite.nuxtjs.org and composition-api.nuxtjs.org to redirect the trafic towards nuxt.com documentation pages about @nuxt/bridge.

If you want to preserve these sites, I'll send a PR upgrading them as well.

cc: @danielroe ;

Do you want me to upgrade typed-vuex docs too? :)


Now that Docus is open source, I would love to maintain a "is using" list.

I'll add all these repositories on readme.md, and would love anyone from you that knows someone using Docus to be pinged here: https://github.com/nuxt-themes/docus/issues/713 👁️

danielroe commented 1 year ago

You are a total star. I think we're not ready to deprecate composition-api.nuxtjs.org but I think we should be able to do that for vite.nuxtjs.org - (what do you think @pi0?).

As for typed-vuex, I would be very grateful but am also happy to do it; I'll happily follow the example of any migrations you do elsewhere.

Tahul commented 1 year ago

@danielroe thank you so much ❤️

I'll do it for typed-vuex and composition-api then :), that is fine for me to do it, as long as it helps me to write the upcoming "migrating" section of docs, even for very old Docus/nuxt-content-theme-docs setups.

I have another small question for you, some of these repositories seem to have an issue booting, defineAppConfig and other auto-imports seem to be undefined.

I was unable to track what is the root cause for this, some contextuals factors are the exact same between one repository that works, and the others that don't.

I suspect it might be coming from a local factor (my laptop/Node setup?), but maybe you've already heard of that before?

Anyways, expect the PRs for remaining repositories soon. 😄

danielroe commented 1 year ago

Likely those repos have explicitly disabled imports.autoImport in .nuxtrc, to prevent issues with runtime files not explicitly importing their auto imports. I'll think about the best way of handling this, but overriding this in docs project seems best.

Atinux commented 1 year ago

Agree with @danielroe

This is what I did for color-mode: https://github.com/nuxt-modules/color-mode/blob/0b900a22738bdef5c786edf06447e5a8fb4844c2/docs/nuxt.config.ts#L5

Tahul commented 1 year ago

Hey :)

Reopening this towards https://github.com/nuxt-themes/docus/pull/909 :)

Tahul commented 1 year ago

@Atinux @danielroe @pi0 @antfu ; any websites from Nuxt modules you would like to see updated that are not in that issue list?

I'll be sending a batch of PRs upgrading existing websites to pre-releases so we can properly test and document the migration from v1 to v2.