docs: simplify the docs directory (#18506)

* docs: simplify docs to only markdown * Create nuxt-config.md * chore: update * chore: add readme
2024-11-22 05:35:13 +00:00 · 2023-01-25 10:41:41 +01:00 · 2023-01-25 10:41:41 +01:00 · 3ec108493d
commit 3ec108493d
parent 9751c9dab7
528 changed files with 20 additions and 21948 deletions
--- a/docs/.env.example
+++ b/docs/.env.example
@ -1,9 +0,0 @@
-# Local version of the website theme
-WEBSITE_THEME=/my/path/to/website-theme
-
-NUXT_SENDGRID_API_KEY=
-NUXT_SENDGRID_LIST_ID=
-
-NUXT_OPEN_COLLECTIVE_API_KEY=
-
-NUXT_GITHUB_TOKEN=
--- a/docs/.eslintrc
+++ b/docs/.eslintrc
@ -1,10 +0,0 @@
-{
-  "settings": {
-    "import/ignore": [
-      "vue"
-    ]
-  },
-  "rules": {
-    "vue/no-v-text-v-html-on-component": "off"
-  }
-}
--- a/docs/.gitignore
+++ b/docs/.gitignore
@ -1,9 +0,0 @@
-schema
-**/*.configuration/nuxt.config.md
-**/*.configuration/nuxt-config.md
-static/sw.js
-
-.yarn/*
-!.yarn/releases
-!yarn.lock
-.vercel
--- a/docs/.yarn/releases/yarn-3.3.1.cjs
+++ b/docs/.yarn/releases/yarn-3.3.1.cjs
--- a/docs/.yarnrc.yml
+++ b/docs/.yarnrc.yml
@ -1,3 +0,0 @@
-nmMode: hardlinks-local
-nodeLinker: node-modules
-yarnPath: .yarn/releases/yarn-3.3.1.cjs
--- a/docs/content/1.docs/0.index.md
+++ b/docs/content/1.docs/0.index.md
--- a/docs/content/1.docs/1.getting-started/1.introduction.md
+++ b/docs/content/1.docs/1.getting-started/1.introduction.md
--- a/docs/content/1.docs/1.getting-started/10.deployment.md
+++ b/docs/content/1.docs/1.getting-started/10.deployment.md
--- a/docs/content/1.docs/1.getting-started/11.testing.md
+++ b/docs/content/1.docs/1.getting-started/11.testing.md
--- a/docs/content/1.docs/1.getting-started/12.upgrade.md
+++ b/docs/content/1.docs/1.getting-started/12.upgrade.md
--- a/docs/content/1.docs/1.getting-started/2.installation.md
+++ b/docs/content/1.docs/1.getting-started/2.installation.md
--- a/docs/content/1.docs/1.getting-started/3.configuration.md
+++ b/docs/content/1.docs/1.getting-started/3.configuration.md
--- a/docs/content/1.docs/1.getting-started/3.views.md
+++ b/docs/content/1.docs/1.getting-started/3.views.md
--- a/docs/content/1.docs/1.getting-started/4.assets.md
+++ b/docs/content/1.docs/1.getting-started/4.assets.md
--- a/docs/content/1.docs/1.getting-started/5.routing.md
+++ b/docs/content/1.docs/1.getting-started/5.routing.md
--- a/docs/content/1.docs/1.getting-started/5.seo-meta.md
+++ b/docs/content/1.docs/1.getting-started/5.seo-meta.md
--- a/docs/content/1.docs/1.getting-started/5.transitions.md
+++ b/docs/content/1.docs/1.getting-started/5.transitions.md
--- a/docs/content/1.docs/1.getting-started/6.data-fetching.md
+++ b/docs/content/1.docs/1.getting-started/6.data-fetching.md
--- a/docs/content/1.docs/1.getting-started/7.state-management.md
+++ b/docs/content/1.docs/1.getting-started/7.state-management.md
--- a/docs/content/1.docs/1.getting-started/8.error-handling.md
+++ b/docs/content/1.docs/1.getting-started/8.error-handling.md
--- a/docs/content/1.docs/1.getting-started/9.layers.md
+++ b/docs/content/1.docs/1.getting-started/9.layers.md
--- a/docs/content/1.docs/1.getting-started/_dir.yml
+++ b/docs/content/1.docs/1.getting-started/_dir.yml
--- a/docs/content/1.docs/2.guide/1.concepts/1.auto-imports.md
+++ b/docs/content/1.docs/2.guide/1.concepts/1.auto-imports.md
--- a/docs/content/1.docs/2.guide/1.concepts/2.vuejs-development.md
+++ b/docs/content/1.docs/2.guide/1.concepts/2.vuejs-development.md
--- a/docs/content/1.docs/2.guide/1.concepts/3.rendering.md
+++ b/docs/content/1.docs/2.guide/1.concepts/3.rendering.md
--- a/docs/content/1.docs/2.guide/1.concepts/4.server-engine.md
+++ b/docs/content/1.docs/2.guide/1.concepts/4.server-engine.md
--- a/docs/content/1.docs/2.guide/1.concepts/5.modules.md
+++ b/docs/content/1.docs/2.guide/1.concepts/5.modules.md
--- a/docs/content/1.docs/2.guide/1.concepts/7.esm.md
+++ b/docs/content/1.docs/2.guide/1.concepts/7.esm.md
--- a/docs/content/1.docs/2.guide/1.concepts/8.typescript.md
+++ b/docs/content/1.docs/2.guide/1.concepts/8.typescript.md
--- a/docs/content/1.docs/2.guide/1.concepts/_dir.yml
+++ b/docs/content/1.docs/2.guide/1.concepts/_dir.yml
--- a/docs/content/1.docs/2.guide/1.concepts/index.md
+++ b/docs/content/1.docs/2.guide/1.concepts/index.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/0.nuxt.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/0.nuxt.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/0.output.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/0.output.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/1.assets.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/1.assets.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/1.components.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/1.components.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/1.composables.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/1.composables.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/1.content.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/1.content.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/1.layouts.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/1.layouts.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/1.middleware.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/1.middleware.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/1.node_modules.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/1.node_modules.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/1.pages.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/1.pages.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/1.plugins.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/1.plugins.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/1.public.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/1.public.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/1.server.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/1.server.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/1.utils.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/1.utils.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/2.gitignore.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/2.gitignore.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/2.nuxtignore.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/2.nuxtignore.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/3.app-config.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/3.app-config.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/3.app.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/3.app.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/3.nuxt.config.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/3.nuxt.config.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/3.package.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/3.package.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/3.tsconfig.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/3.tsconfig.md
--- a/docs/content/1.docs/2.guide/2.directory-structure/_dir.yml
+++ b/docs/content/1.docs/2.guide/2.directory-structure/_dir.yml
--- a/docs/content/1.docs/2.guide/2.directory-structure/index.md
+++ b/docs/content/1.docs/2.guide/2.directory-structure/index.md
--- a/docs/content/1.docs/2.guide/3.going-further/1.internals.md
+++ b/docs/content/1.docs/2.guide/3.going-further/1.internals.md
--- a/docs/content/1.docs/2.guide/3.going-further/10.runtime-config.md
+++ b/docs/content/1.docs/2.guide/3.going-further/10.runtime-config.md
--- a/docs/content/1.docs/2.guide/3.going-further/11.edge-channel.md
+++ b/docs/content/1.docs/2.guide/3.going-further/11.edge-channel.md
--- a/docs/content/1.docs/2.guide/3.going-further/2.hooks.md
+++ b/docs/content/1.docs/2.guide/3.going-further/2.hooks.md
--- a/docs/content/1.docs/2.guide/3.going-further/3.modules.md
+++ b/docs/content/1.docs/2.guide/3.going-further/3.modules.md
--- a/docs/content/1.docs/2.guide/3.going-further/4.kit.md
+++ b/docs/content/1.docs/2.guide/3.going-further/4.kit.md
--- a/docs/content/1.docs/2.guide/3.going-further/6.nuxt-app.md
+++ b/docs/content/1.docs/2.guide/3.going-further/6.nuxt-app.md
--- a/docs/content/1.docs/2.guide/3.going-further/7.layers.md
+++ b/docs/content/1.docs/2.guide/3.going-further/7.layers.md
--- a/docs/content/1.docs/2.guide/3.going-further/_dir.yml
+++ b/docs/content/1.docs/2.guide/3.going-further/_dir.yml
--- a/docs/content/1.docs/2.guide/3.going-further/index.md
+++ b/docs/content/1.docs/2.guide/3.going-further/index.md
--- a/docs/content/1.docs/2.guide/_dir.yml
+++ b/docs/content/1.docs/2.guide/_dir.yml
--- a/docs/content/1.docs/2.guide/index.md
+++ b/docs/content/1.docs/2.guide/index.md
--- a/docs/content/1.docs/3.api/1.composables/_dir.yml
+++ b/docs/content/1.docs/3.api/1.composables/_dir.yml
--- a/docs/content/1.docs/3.api/1.composables/use-app-config.md
+++ b/docs/content/1.docs/3.api/1.composables/use-app-config.md
--- a/docs/content/1.docs/3.api/1.composables/use-async-data.md
+++ b/docs/content/1.docs/3.api/1.composables/use-async-data.md
--- a/docs/content/1.docs/3.api/1.composables/use-cookie.md
+++ b/docs/content/1.docs/3.api/1.composables/use-cookie.md
--- a/docs/content/1.docs/3.api/1.composables/use-error.md
+++ b/docs/content/1.docs/3.api/1.composables/use-error.md
--- a/docs/content/1.docs/3.api/1.composables/use-fetch.md
+++ b/docs/content/1.docs/3.api/1.composables/use-fetch.md
--- a/docs/content/1.docs/3.api/1.composables/use-head.md
+++ b/docs/content/1.docs/3.api/1.composables/use-head.md
--- a/docs/content/1.docs/3.api/1.composables/use-hydration.md
+++ b/docs/content/1.docs/3.api/1.composables/use-hydration.md
--- a/docs/content/1.docs/3.api/1.composables/use-lazy-async-data.md
+++ b/docs/content/1.docs/3.api/1.composables/use-lazy-async-data.md
--- a/docs/content/1.docs/3.api/1.composables/use-lazy-fetch.md
+++ b/docs/content/1.docs/3.api/1.composables/use-lazy-fetch.md
--- a/docs/content/1.docs/3.api/1.composables/use-nuxt-app.md
+++ b/docs/content/1.docs/3.api/1.composables/use-nuxt-app.md
--- a/docs/content/1.docs/3.api/1.composables/use-nuxt-data.md
+++ b/docs/content/1.docs/3.api/1.composables/use-nuxt-data.md
--- a/docs/content/1.docs/3.api/1.composables/use-request-event.md
+++ b/docs/content/1.docs/3.api/1.composables/use-request-event.md
--- a/docs/content/1.docs/3.api/1.composables/use-request-headers.md
+++ b/docs/content/1.docs/3.api/1.composables/use-request-headers.md
--- a/docs/content/1.docs/3.api/1.composables/use-route.md
+++ b/docs/content/1.docs/3.api/1.composables/use-route.md
--- a/docs/content/1.docs/3.api/1.composables/use-router.md
+++ b/docs/content/1.docs/3.api/1.composables/use-router.md
--- a/docs/content/1.docs/3.api/1.composables/use-runtime-config.md
+++ b/docs/content/1.docs/3.api/1.composables/use-runtime-config.md
--- a/docs/content/1.docs/3.api/1.composables/use-state.md
+++ b/docs/content/1.docs/3.api/1.composables/use-state.md
--- a/docs/content/1.docs/3.api/2.components/1.client-only.md
+++ b/docs/content/1.docs/3.api/2.components/1.client-only.md
--- a/docs/content/1.docs/3.api/2.components/2.nuxt-page.md
+++ b/docs/content/1.docs/3.api/2.components/2.nuxt-page.md
--- a/docs/content/1.docs/3.api/2.components/3.nuxt-layout.md
+++ b/docs/content/1.docs/3.api/2.components/3.nuxt-layout.md
--- a/docs/content/1.docs/3.api/2.components/4.nuxt-link.md
+++ b/docs/content/1.docs/3.api/2.components/4.nuxt-link.md
--- a/docs/content/1.docs/3.api/2.components/5.nuxt-loading-indicator.md
+++ b/docs/content/1.docs/3.api/2.components/5.nuxt-loading-indicator.md
--- a/docs/content/1.docs/3.api/2.components/6.nuxt-error-boundary.md
+++ b/docs/content/1.docs/3.api/2.components/6.nuxt-error-boundary.md
--- a/docs/content/1.docs/3.api/2.components/7.nuxt-welcome.md
+++ b/docs/content/1.docs/3.api/2.components/7.nuxt-welcome.md
--- a/docs/content/1.docs/3.api/2.components/8.teleports.md
+++ b/docs/content/1.docs/3.api/2.components/8.teleports.md
--- a/docs/content/1.docs/3.api/2.components/_dir.yml
+++ b/docs/content/1.docs/3.api/2.components/_dir.yml
--- a/docs/content/1.docs/3.api/2.components/index.md
+++ b/docs/content/1.docs/3.api/2.components/index.md
--- a/docs/content/1.docs/3.api/3.utils/$fetch.md
+++ b/docs/content/1.docs/3.api/3.utils/$fetch.md
--- a/docs/content/1.docs/3.api/3.utils/_dir.yml
+++ b/docs/content/1.docs/3.api/3.utils/_dir.yml
--- a/docs/content/1.docs/3.api/3.utils/abort-navigation.md
+++ b/docs/content/1.docs/3.api/3.utils/abort-navigation.md
--- a/docs/content/1.docs/3.api/3.utils/add-route-middleware.md
+++ b/docs/content/1.docs/3.api/3.utils/add-route-middleware.md
--- a/docs/content/1.docs/3.api/3.utils/clear-error.md
+++ b/docs/content/1.docs/3.api/3.utils/clear-error.md
--- a/docs/content/1.docs/3.api/3.utils/clear-nuxt-data.md
+++ b/docs/content/1.docs/3.api/3.utils/clear-nuxt-data.md
--- a/Show More
+++ b/Show More