From 1a7b570c82311e04812b1bfc913c455d9218d133 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Ollivier?= Date: Wed, 30 Mar 2022 17:59:28 +0200 Subject: [PATCH] docs(examples): add examples to docs (#3966) Co-authored-by: Pooya Parsa --- docs/components/app/AppLayout.vue | 7 +- docs/components/atoms/Sandbox.vue | 107 +++++++++++++++++ docs/components/templates/Example.vue | 45 ++++++++ .../4.examples/0.essentials/hello-world.md | 13 +++ .../4.examples/1.app/error-handling.md | 13 +++ docs/content/4.examples/1.app/plugins.md | 13 +++ .../4.examples/2.auto-imports/components.md | 14 +++ .../4.examples/2.auto-imports/composables.md | 14 +++ .../3.composables/use-async-data.md | 17 +++ .../4.examples/3.composables/use-cookie.md | 13 +++ .../4.examples/3.composables/use-fetch.md | 17 +++ .../4.examples/3.composables/use-meta.md | 13 +++ .../4.examples/3.composables/use-state.md | 13 +++ docs/content/4.examples/4.routing/layouts.md | 13 +++ .../4.examples/4.routing/middleware.md | 13 +++ .../content/4.examples/4.routing/nuxt-link.md | 17 +++ docs/content/4.examples/4.routing/pages.md | 13 +++ .../4.examples/4.routing/universal-router.md | 9 ++ .../4.examples/5.advanced/config-extends.md | 9 ++ .../5.advanced/module-extend-pages.md | 13 +++ docs/content/4.examples/5.advanced/test.md | 7 ++ .../6.experimental/reactivity-transform.md | 13 +++ .../content/4.examples/6.experimental/wasm.md | 9 ++ docs/content/4.examples/7.other/locale.md | 13 +++ docs/content/4.examples/index.md | 9 ++ .../1.getting-help.md | 0 .../2.reporting-bugs.md | 0 .../3.contribution.md | 0 .../{4.community => 5.community}/4.roadmap.md | 0 .../{4.community => 5.community}/index.md | 0 docs/content/_collections/header.md | 3 + examples/README.md | 14 +-- .../base/components/BaseButton.vue | 0 .../base/components/FancyButton.vue | 0 .../config-extends/base/composables/foo.ts | 0 .../config-extends/base/middleware/foo.ts | 0 .../config-extends/base/nuxt.config.ts | 0 .../config-extends/base/pages/foo.vue | 0 .../config-extends/base/plugins/my-plugin.ts | 0 .../config-extends/base/server/api/base.ts | 0 .../config-extends/base/utils/bar.ts | 0 .../config-extends/components/FancyButton.vue | 0 .../config-extends/nuxt.config.ts | 0 .../config-extends/package.json | 0 .../config-extends/pages/index.vue | 7 +- .../config-extends/server/api/hello.ts | 0 .../config-extends/tsconfig.json | 0 .../config-extends/ui/components/Button.vue | 0 .../config-extends/ui/nuxt.config.ts | 0 .../module-extend-pages/layouts/default.vue | 5 + .../modules/pages/index.ts | 0 .../modules/pages/pages/test.vue | 0 .../module-extend-pages/nuxt.config.ts | 0 .../module-extend-pages/package.json | 0 .../module-extend-pages/pages/index.vue | 0 .../module-extend-pages}/tsconfig.json | 0 examples/{with-test => advanced/test}/app.vue | 0 .../test}/nuxt.config.ts | 0 .../{with-test => advanced/test}/package.json | 2 +- .../test}/tests/basic.test.ts | 0 .../{locale => advanced/test}/tsconfig.json | 0 .../error-handling}/app.vue | 10 +- .../components/FaultyComponent.vue | 0 .../error-handling}/components/ThrowError.vue | 0 .../error-handling}/error.vue | 0 .../middleware/error.global.ts | 0 .../error-handling}/nuxt.config.ts | 0 .../error-handling}/package.json | 2 +- .../error-handling}/pages/index.vue | 0 .../error-handling}/pages/other.vue | 0 .../error-handling}/plugins/error.ts | 0 .../server/middleware/error.ts | 0 .../error-handling}/tsconfig.json | 0 examples/app/plugins/app.vue | 5 + .../{nuxt-link => app/plugins}/nuxt.config.ts | 0 .../{with-wasm => app/plugins}/package.json | 12 +- .../plugins}/plugins/my-plugin.ts | 0 .../{nuxt-link => app/plugins}/tsconfig.json | 0 examples/auto-imports/components/app.vue | 14 +++ .../components}/components/HelloWorld.vue | 0 .../components}/components/Nuxt3.vue | 0 .../components/parent-folder/Hello.vue | 0 .../components}/nuxt.config.ts | 0 .../other-components-folder/with-prefix.vue | 0 .../components}/package.json | 2 +- .../components}/tsconfig.json | 0 examples/auto-imports/composables/app.vue | 17 +++ .../composables}/composables/use-foo.ts | 0 .../composables}/nuxt.config.ts | 0 .../composables}/package.json | 2 +- .../{ => composables}/use-async-data/app.vue | 17 +-- .../components/CounterExample.vue | 0 .../components/MountainExample.vue | 0 .../use-async-data}/nuxt.config.ts | 0 .../use-async-data/package.json | 0 .../use-async-data/server/api/hello.js | 0 .../use-async-data}/tsconfig.json | 0 examples/{ => composables}/use-cookie/app.vue | 12 +- .../use-cookie}/nuxt.config.ts | 0 .../{ => composables}/use-cookie/package.json | 0 .../use-cookie}/tsconfig.json | 0 examples/composables/use-fetch/app.vue | 16 +++ .../use-fetch}/nuxt.config.ts | 0 .../{ => composables}/use-fetch/package.json | 0 .../use-fetch/server/api/hello.ts | 0 .../use-fetch}/tsconfig.json | 0 examples/{ => composables}/use-meta/app.vue | 17 +-- .../use-meta}/nuxt.config.ts | 0 .../{ => composables}/use-meta/package.json | 0 .../use-meta}/tsconfig.json | 0 examples/composables/use-state/app.vue | 17 +++ .../use-state}/nuxt.config.ts | 0 .../{ => composables}/use-state/package.json | 0 .../{ => composables}/use-state/tsconfig.json | 0 examples/{ => essentials}/hello-world/app.vue | 0 .../hello-world}/nuxt.config.ts | 0 .../{ => essentials}/hello-world/package.json | 0 .../hello-world}/tsconfig.json | 0 .../experimental/reactivity-transform/app.vue | 26 +++++ .../components/label.vue | 0 .../reactivity-transform}/nuxt.config.ts | 0 .../reactivity-transform}/package.json | 2 +- .../reactivity-transform}/tsconfig.json | 0 .../{with-wasm => experimental/wasm}/app.vue | 8 +- .../wasm}/nuxt.config.ts | 0 .../wasm}/package.json | 12 +- .../wasm}/server/api/sum.ts | 0 .../wasm}/server/wasm/sum.wasm | Bin .../wasm}/server/wasm/sum.wat | 0 .../wasm}/tsconfig.json | 0 .../module-extend-pages/layouts/default.vue | 10 -- examples/nuxt-link/app.vue | 19 --- examples/{ => other}/locale/app.vue | 11 +- .../{ => other}/locale/composables/locale.ts | 0 .../locale}/nuxt.config.ts | 0 examples/{ => other}/locale/package.json | 0 .../locale}/tsconfig.json | 0 .../layouts}/layouts/custom.vue | 0 .../layouts}/layouts/default.vue | 0 .../layouts}/layouts/other.vue | 0 .../layouts}/nuxt.config.ts | 0 examples/routing/layouts/package.json | 13 +++ .../layouts}/pages/custom.vue | 0 .../layouts}/pages/default.vue | 0 .../layouts}/pages/dynamic.vue | 0 .../layouts}/pages/index.vue | 11 +- .../layouts}/tsconfig.json | 0 .../middleware}/app.vue | 10 +- .../middleware/always-run.global.ts | 0 .../middleware}/middleware/redirect-me.ts | 0 .../middleware}/nuxt.config.ts | 0 examples/routing/middleware/package.json | 13 +++ .../middleware}/pages/forbidden.vue | 0 .../middleware}/pages/index.vue | 0 .../middleware}/pages/redirect.vue | 0 .../middleware}/pages/secret.vue | 0 .../middleware}/plugins/add.ts | 0 .../middleware}/tsconfig.json | 0 examples/routing/nuxt-link/app.vue | 13 +++ .../nuxt-link/components/MyNuxtLink.js | 0 .../nuxt-link}/nuxt.config.ts | 0 examples/{ => routing}/nuxt-link/package.json | 0 .../{ => routing}/nuxt-link/pages/about.vue | 0 .../{ => routing}/nuxt-link/pages/index.vue | 0 .../nuxt-link}/tsconfig.json | 0 .../{with-pages => routing/pages}/app.vue | 11 +- .../pages}/nuxt.config.ts | 0 examples/routing/pages/package.json | 13 +++ .../pages}/pages/about.vue | 0 .../pages}/pages/catchall/[...id].vue | 0 .../pages}/pages/index.vue | 0 .../pages}/pages/parent.vue | 0 .../pages}/pages/parent/b.vue | 0 .../pages}/pages/parent/index.vue | 0 .../pages}/pages/parent/reload-[id].vue | 0 .../pages}/pages/parent/static-[id].vue | 0 .../pages}/tsconfig.json | 0 .../universal-router}/app.vue | 10 +- .../universal-router}/nuxt.config.ts | 0 .../universal-router}/package.json | 2 +- .../universal-router}/plugins/add.ts | 0 .../universal-router}/tsconfig.json | 0 examples/use-fetch/app.vue | 31 ----- examples/use-state/app.vue | 28 ----- examples/with-components/app.vue | 27 ----- examples/with-components/nuxt.d.ts | 9 -- examples/with-composables/app.vue | 38 ------ examples/with-middleware/package.json | 13 --- examples/with-plugins/app.vue | 14 --- examples/with-reactivity-transform/app.vue | 40 ------- .../with-reactivity-transform/package.json | 13 --- examples/with-universal-router/package.json | 13 --- package.json | 2 +- yarn.lock | 108 +++++++++--------- 194 files changed, 682 insertions(+), 449 deletions(-) create mode 100644 docs/components/atoms/Sandbox.vue create mode 100644 docs/components/templates/Example.vue create mode 100644 docs/content/4.examples/0.essentials/hello-world.md create mode 100644 docs/content/4.examples/1.app/error-handling.md create mode 100644 docs/content/4.examples/1.app/plugins.md create mode 100644 docs/content/4.examples/2.auto-imports/components.md create mode 100644 docs/content/4.examples/2.auto-imports/composables.md create mode 100644 docs/content/4.examples/3.composables/use-async-data.md create mode 100644 docs/content/4.examples/3.composables/use-cookie.md create mode 100644 docs/content/4.examples/3.composables/use-fetch.md create mode 100644 docs/content/4.examples/3.composables/use-meta.md create mode 100644 docs/content/4.examples/3.composables/use-state.md create mode 100644 docs/content/4.examples/4.routing/layouts.md create mode 100644 docs/content/4.examples/4.routing/middleware.md create mode 100644 docs/content/4.examples/4.routing/nuxt-link.md create mode 100644 docs/content/4.examples/4.routing/pages.md create mode 100644 docs/content/4.examples/4.routing/universal-router.md create mode 100644 docs/content/4.examples/5.advanced/config-extends.md create mode 100644 docs/content/4.examples/5.advanced/module-extend-pages.md create mode 100644 docs/content/4.examples/5.advanced/test.md create mode 100644 docs/content/4.examples/6.experimental/reactivity-transform.md create mode 100644 docs/content/4.examples/6.experimental/wasm.md create mode 100644 docs/content/4.examples/7.other/locale.md create mode 100644 docs/content/4.examples/index.md rename docs/content/{4.community => 5.community}/1.getting-help.md (100%) rename docs/content/{4.community => 5.community}/2.reporting-bugs.md (100%) rename docs/content/{4.community => 5.community}/3.contribution.md (100%) rename docs/content/{4.community => 5.community}/4.roadmap.md (100%) rename docs/content/{4.community => 5.community}/index.md (100%) rename examples/{ => advanced}/config-extends/base/components/BaseButton.vue (100%) rename examples/{ => advanced}/config-extends/base/components/FancyButton.vue (100%) rename examples/{ => advanced}/config-extends/base/composables/foo.ts (100%) rename examples/{ => advanced}/config-extends/base/middleware/foo.ts (100%) rename examples/{ => advanced}/config-extends/base/nuxt.config.ts (100%) rename examples/{ => advanced}/config-extends/base/pages/foo.vue (100%) rename examples/{ => advanced}/config-extends/base/plugins/my-plugin.ts (100%) rename examples/{ => advanced}/config-extends/base/server/api/base.ts (100%) rename examples/{ => advanced}/config-extends/base/utils/bar.ts (100%) rename examples/{ => advanced}/config-extends/components/FancyButton.vue (100%) rename examples/{ => advanced}/config-extends/nuxt.config.ts (100%) rename examples/{ => advanced}/config-extends/package.json (100%) rename examples/{ => advanced}/config-extends/pages/index.vue (57%) rename examples/{ => advanced}/config-extends/server/api/hello.ts (100%) rename examples/{ => advanced}/config-extends/tsconfig.json (100%) rename examples/{ => advanced}/config-extends/ui/components/Button.vue (100%) rename examples/{ => advanced}/config-extends/ui/nuxt.config.ts (100%) create mode 100644 examples/advanced/module-extend-pages/layouts/default.vue rename examples/{ => advanced}/module-extend-pages/modules/pages/index.ts (100%) rename examples/{ => advanced}/module-extend-pages/modules/pages/pages/test.vue (100%) rename examples/{ => advanced}/module-extend-pages/nuxt.config.ts (100%) rename examples/{ => advanced}/module-extend-pages/package.json (100%) rename examples/{ => advanced}/module-extend-pages/pages/index.vue (100%) rename examples/{hello-world => advanced/module-extend-pages}/tsconfig.json (100%) rename examples/{with-test => advanced/test}/app.vue (100%) rename examples/{hello-world => advanced/test}/nuxt.config.ts (100%) rename examples/{with-test => advanced/test}/package.json (84%) rename examples/{with-test => advanced/test}/tests/basic.test.ts (100%) rename examples/{locale => advanced/test}/tsconfig.json (100%) rename examples/{with-errors => app/error-handling}/app.vue (76%) rename examples/{with-errors => app/error-handling}/components/FaultyComponent.vue (100%) rename examples/{with-errors => app/error-handling}/components/ThrowError.vue (100%) rename examples/{with-errors => app/error-handling}/error.vue (100%) rename examples/{with-errors => app/error-handling}/middleware/error.global.ts (100%) rename examples/{locale => app/error-handling}/nuxt.config.ts (100%) rename examples/{with-plugins => app/error-handling}/package.json (85%) rename examples/{with-errors => app/error-handling}/pages/index.vue (100%) rename examples/{with-errors => app/error-handling}/pages/other.vue (100%) rename examples/{with-errors => app/error-handling}/plugins/error.ts (100%) rename examples/{with-errors => app/error-handling}/server/middleware/error.ts (100%) rename examples/{module-extend-pages => app/error-handling}/tsconfig.json (100%) create mode 100644 examples/app/plugins/app.vue rename examples/{nuxt-link => app/plugins}/nuxt.config.ts (100%) rename examples/{with-wasm => app/plugins}/package.json (87%) rename examples/{with-plugins => app/plugins}/plugins/my-plugin.ts (100%) rename examples/{nuxt-link => app/plugins}/tsconfig.json (100%) create mode 100644 examples/auto-imports/components/app.vue rename examples/{with-components => auto-imports/components}/components/HelloWorld.vue (100%) rename examples/{with-components => auto-imports/components}/components/Nuxt3.vue (100%) rename examples/{with-components => auto-imports/components}/components/parent-folder/Hello.vue (100%) rename examples/{with-components => auto-imports/components}/nuxt.config.ts (100%) rename examples/{with-components => auto-imports/components}/other-components-folder/with-prefix.vue (100%) rename examples/{with-pages => auto-imports/components}/package.json (86%) rename examples/{use-async-data => auto-imports/components}/tsconfig.json (100%) create mode 100644 examples/auto-imports/composables/app.vue rename examples/{with-composables => auto-imports/composables}/composables/use-foo.ts (100%) rename examples/{use-async-data => auto-imports/composables}/nuxt.config.ts (100%) rename examples/{with-errors => auto-imports/composables}/package.json (86%) rename examples/{ => composables}/use-async-data/app.vue (55%) rename examples/{ => composables}/use-async-data/components/CounterExample.vue (100%) rename examples/{ => composables}/use-async-data/components/MountainExample.vue (100%) rename examples/{use-cookie => composables/use-async-data}/nuxt.config.ts (100%) rename examples/{ => composables}/use-async-data/package.json (100%) rename examples/{ => composables}/use-async-data/server/api/hello.js (100%) rename examples/{use-cookie => composables/use-async-data}/tsconfig.json (100%) rename examples/{ => composables}/use-cookie/app.vue (74%) rename examples/{use-fetch => composables/use-cookie}/nuxt.config.ts (100%) rename examples/{ => composables}/use-cookie/package.json (100%) rename examples/{use-fetch => composables/use-cookie}/tsconfig.json (100%) create mode 100644 examples/composables/use-fetch/app.vue rename examples/{use-meta => composables/use-fetch}/nuxt.config.ts (100%) rename examples/{ => composables}/use-fetch/package.json (100%) rename examples/{ => composables}/use-fetch/server/api/hello.ts (100%) rename examples/{use-meta => composables/use-fetch}/tsconfig.json (100%) rename examples/{ => composables}/use-meta/app.vue (64%) rename examples/{use-state => composables/use-meta}/nuxt.config.ts (100%) rename examples/{ => composables}/use-meta/package.json (100%) rename examples/{with-components => composables/use-meta}/tsconfig.json (100%) create mode 100644 examples/composables/use-state/app.vue rename examples/{with-composables => composables/use-state}/nuxt.config.ts (100%) rename examples/{ => composables}/use-state/package.json (100%) rename examples/{ => composables}/use-state/tsconfig.json (100%) rename examples/{ => essentials}/hello-world/app.vue (100%) rename examples/{with-test => essentials/hello-world}/nuxt.config.ts (100%) rename examples/{ => essentials}/hello-world/package.json (100%) rename examples/{with-errors => essentials/hello-world}/tsconfig.json (100%) create mode 100644 examples/experimental/reactivity-transform/app.vue rename examples/{with-reactivity-transform => experimental/reactivity-transform}/components/label.vue (100%) rename examples/{with-reactivity-transform => experimental/reactivity-transform}/nuxt.config.ts (100%) rename examples/{with-composables => experimental/reactivity-transform}/package.json (83%) rename examples/{with-layouts => experimental/reactivity-transform}/tsconfig.json (100%) rename examples/{with-wasm => experimental/wasm}/app.vue (69%) rename examples/{with-wasm => experimental/wasm}/nuxt.config.ts (100%) rename examples/{with-layouts => experimental/wasm}/package.json (86%) rename examples/{with-wasm => experimental/wasm}/server/api/sum.ts (100%) rename examples/{with-wasm => experimental/wasm}/server/wasm/sum.wasm (100%) rename examples/{with-wasm => experimental/wasm}/server/wasm/sum.wat (100%) rename examples/{with-middleware => experimental/wasm}/tsconfig.json (100%) delete mode 100644 examples/module-extend-pages/layouts/default.vue delete mode 100644 examples/nuxt-link/app.vue rename examples/{ => other}/locale/app.vue (63%) rename examples/{ => other}/locale/composables/locale.ts (100%) rename examples/{with-errors => other/locale}/nuxt.config.ts (100%) rename examples/{ => other}/locale/package.json (100%) rename examples/{with-pages => other/locale}/tsconfig.json (100%) rename examples/{with-layouts => routing/layouts}/layouts/custom.vue (100%) rename examples/{with-layouts => routing/layouts}/layouts/default.vue (100%) rename examples/{with-layouts => routing/layouts}/layouts/other.vue (100%) rename examples/{with-layouts => routing/layouts}/nuxt.config.ts (100%) create mode 100644 examples/routing/layouts/package.json rename examples/{with-layouts => routing/layouts}/pages/custom.vue (100%) rename examples/{with-layouts => routing/layouts}/pages/default.vue (100%) rename examples/{with-layouts => routing/layouts}/pages/dynamic.vue (100%) rename examples/{with-layouts => routing/layouts}/pages/index.vue (53%) rename examples/{with-plugins => routing/layouts}/tsconfig.json (100%) rename examples/{with-middleware => routing/middleware}/app.vue (59%) rename examples/{with-middleware => routing/middleware}/middleware/always-run.global.ts (100%) rename examples/{with-middleware => routing/middleware}/middleware/redirect-me.ts (100%) rename examples/{with-middleware => routing/middleware}/nuxt.config.ts (100%) create mode 100644 examples/routing/middleware/package.json rename examples/{with-middleware => routing/middleware}/pages/forbidden.vue (100%) rename examples/{with-middleware => routing/middleware}/pages/index.vue (100%) rename examples/{with-middleware => routing/middleware}/pages/redirect.vue (100%) rename examples/{with-middleware => routing/middleware}/pages/secret.vue (100%) rename examples/{with-middleware => routing/middleware}/plugins/add.ts (100%) rename examples/{with-reactivity-transform => routing/middleware}/tsconfig.json (100%) create mode 100644 examples/routing/nuxt-link/app.vue rename examples/{ => routing}/nuxt-link/components/MyNuxtLink.js (100%) rename examples/{with-pages => routing/nuxt-link}/nuxt.config.ts (100%) rename examples/{ => routing}/nuxt-link/package.json (100%) rename examples/{ => routing}/nuxt-link/pages/about.vue (100%) rename examples/{ => routing}/nuxt-link/pages/index.vue (100%) rename examples/{with-test => routing/nuxt-link}/tsconfig.json (100%) rename examples/{with-pages => routing/pages}/app.vue (75%) rename examples/{with-plugins => routing/pages}/nuxt.config.ts (100%) create mode 100644 examples/routing/pages/package.json rename examples/{with-pages => routing/pages}/pages/about.vue (100%) rename examples/{with-pages => routing/pages}/pages/catchall/[...id].vue (100%) rename examples/{with-pages => routing/pages}/pages/index.vue (100%) rename examples/{with-pages => routing/pages}/pages/parent.vue (100%) rename examples/{with-pages => routing/pages}/pages/parent/b.vue (100%) rename examples/{with-pages => routing/pages}/pages/parent/index.vue (100%) rename examples/{with-pages => routing/pages}/pages/parent/reload-[id].vue (100%) rename examples/{with-pages => routing/pages}/pages/parent/static-[id].vue (100%) rename examples/{with-universal-router => routing/pages}/tsconfig.json (100%) rename examples/{with-universal-router => routing/universal-router}/app.vue (74%) rename examples/{with-universal-router => routing/universal-router}/nuxt.config.ts (100%) rename examples/{with-components => routing/universal-router}/package.json (84%) rename examples/{with-universal-router => routing/universal-router}/plugins/add.ts (100%) rename examples/{with-wasm => routing/universal-router}/tsconfig.json (100%) delete mode 100644 examples/use-fetch/app.vue delete mode 100644 examples/use-state/app.vue delete mode 100644 examples/with-components/app.vue delete mode 100644 examples/with-components/nuxt.d.ts delete mode 100644 examples/with-composables/app.vue delete mode 100644 examples/with-middleware/package.json delete mode 100644 examples/with-plugins/app.vue delete mode 100644 examples/with-reactivity-transform/app.vue delete mode 100644 examples/with-reactivity-transform/package.json delete mode 100644 examples/with-universal-router/package.json diff --git a/docs/components/app/AppLayout.vue b/docs/components/app/AppLayout.vue index 6d13cfc2ac..18b862f46e 100644 --- a/docs/components/app/AppLayout.vue +++ b/docs/components/app/AppLayout.vue @@ -2,7 +2,7 @@
-
+
@@ -33,6 +33,11 @@ export default defineComponent({ computed: { layout () { return this.$docus.layout.value + }, + containerClass () { + if (this.layout.aside && this.layout.fluid) { return 'd-container-fluid' } + if (this.layout.aside) { return 'd-container' } + return '' } } }) diff --git a/docs/components/atoms/Sandbox.vue b/docs/components/atoms/Sandbox.vue new file mode 100644 index 0000000000..4186b04149 --- /dev/null +++ b/docs/components/atoms/Sandbox.vue @@ -0,0 +1,107 @@ +