From 106c97464ef581ca5cc7bb0e850b706b60f8c421 Mon Sep 17 00:00:00 2001 From: productdevbook Date: Thu, 4 Jan 2024 08:10:25 +0300 Subject: [PATCH] feat: docs --- .docs/.gitignore | 24 + .docs/.npmrc | 1 + .docs/.vscode/settings.json | 3 + .docs/README.md | 75 + .docs/[...slug].vue | 33 + .docs/app.config.ts | 192 + .docs/app.vue | 78 + .docs/components/MotionHeader.vue | 55 + .docs/components/MotionLogo.vue | 59 + .docs/components/OgImage/OGImagePergel.vue | 104 + .docs/components/content/ReadMore.vue | 25 + .docs/components/content/YoutubeVideo.vue | 19 + .docs/composables/useNavigation.ts | 59 + .../1.getting-started/1.introduction.md | 17 + .../motion/1.getting-started/2.install.md | 73 + .../content/motion/1.getting-started/_dir.yml | 3 + .docs/content/motion/2.use/1.index.md | 169 + .docs/content/motion/2.use/_dir.yml | 2 + .docs/content/motion/3.examples/1.index.md | 52 + .../motion/3.examples/2.installation.md | 79 + .docs/content/motion/3.examples/_dir.yml | 2 + .../3.examples/bullmq/1.installation.md | 187 + .../content/motion/3.examples/bullmq/2.api.md | 35 + .../content/motion/3.examples/bullmq/_dir.yml | 2 + .../motion/4.community/1.getting-help.md | 9 + .docs/content/motion/4.community/_dir.yml | 2 + .docs/content/motion/_dir.yml | 2 + .docs/layouts/motion.vue | 71 + .docs/nuxt.config.ts | 67 + .docs/package.json | 32 + .docs/pages/index.vue | 3 + .docs/pages/motion/[...slug]/index.vue | 132 + .docs/pages/motion/index.vue | 79 + .docs/pnpm-lock.yaml | 8720 +++++++++++++++++ .docs/pnpm-workspace.yaml | 0 .docs/public/favicon.ico | Bin 0 -> 4286 bytes .docs/server/tsconfig.json | 3 + .docs/tailwind.config.ts | 19 + .docs/tsconfig.json | 4 + .docs/utils/index.ts | 8 + 40 files changed, 10499 insertions(+) create mode 100644 .docs/.gitignore create mode 100644 .docs/.npmrc create mode 100644 .docs/.vscode/settings.json create mode 100644 .docs/README.md create mode 100644 .docs/[...slug].vue create mode 100644 .docs/app.config.ts create mode 100644 .docs/app.vue create mode 100644 .docs/components/MotionHeader.vue create mode 100644 .docs/components/MotionLogo.vue create mode 100644 .docs/components/OgImage/OGImagePergel.vue create mode 100644 .docs/components/content/ReadMore.vue create mode 100644 .docs/components/content/YoutubeVideo.vue create mode 100644 .docs/composables/useNavigation.ts create mode 100644 .docs/content/motion/1.getting-started/1.introduction.md create mode 100644 .docs/content/motion/1.getting-started/2.install.md create mode 100644 .docs/content/motion/1.getting-started/_dir.yml create mode 100644 .docs/content/motion/2.use/1.index.md create mode 100644 .docs/content/motion/2.use/_dir.yml create mode 100644 .docs/content/motion/3.examples/1.index.md create mode 100644 .docs/content/motion/3.examples/2.installation.md create mode 100644 .docs/content/motion/3.examples/_dir.yml create mode 100644 .docs/content/motion/3.examples/bullmq/1.installation.md create mode 100644 .docs/content/motion/3.examples/bullmq/2.api.md create mode 100644 .docs/content/motion/3.examples/bullmq/_dir.yml create mode 100644 .docs/content/motion/4.community/1.getting-help.md create mode 100644 .docs/content/motion/4.community/_dir.yml create mode 100644 .docs/content/motion/_dir.yml create mode 100644 .docs/layouts/motion.vue create mode 100644 .docs/nuxt.config.ts create mode 100644 .docs/package.json create mode 100644 .docs/pages/index.vue create mode 100644 .docs/pages/motion/[...slug]/index.vue create mode 100644 .docs/pages/motion/index.vue create mode 100644 .docs/pnpm-lock.yaml create mode 100644 .docs/pnpm-workspace.yaml create mode 100644 .docs/public/favicon.ico create mode 100644 .docs/server/tsconfig.json create mode 100644 .docs/tailwind.config.ts create mode 100644 .docs/tsconfig.json create mode 100644 .docs/utils/index.ts diff --git a/.docs/.gitignore b/.docs/.gitignore new file mode 100644 index 0000000..4a7f73a --- /dev/null +++ b/.docs/.gitignore @@ -0,0 +1,24 @@ +# Nuxt dev/build outputs +.output +.data +.nuxt +.nitro +.cache +dist + +# Node dependencies +node_modules + +# Logs +logs +*.log + +# Misc +.DS_Store +.fleet +.idea + +# Local env files +.env +.env.* +!.env.example diff --git a/.docs/.npmrc b/.docs/.npmrc new file mode 100644 index 0000000..c483022 --- /dev/null +++ b/.docs/.npmrc @@ -0,0 +1 @@ +shamefully-hoist=true \ No newline at end of file diff --git a/.docs/.vscode/settings.json b/.docs/.vscode/settings.json new file mode 100644 index 0000000..0b7e341 --- /dev/null +++ b/.docs/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "references.preferredLocation": "peek" +} diff --git a/.docs/README.md b/.docs/README.md new file mode 100644 index 0000000..f5db2a2 --- /dev/null +++ b/.docs/README.md @@ -0,0 +1,75 @@ +# Nuxt 3 Minimal Starter + +Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more. + +## Setup + +Make sure to install the dependencies: + +```bash +# npm +npm install + +# pnpm +pnpm install + +# yarn +yarn install + +# bun +bun install +``` + +## Development Server + +Start the development server on `http://localhost:3000`: + +```bash +# npm +npm run dev + +# pnpm +pnpm run dev + +# yarn +yarn dev + +# bun +bun run dev +``` + +## Production + +Build the application for production: + +```bash +# npm +npm run build + +# pnpm +pnpm run build + +# yarn +yarn build + +# bun +bun run build +``` + +Locally preview production build: + +```bash +# npm +npm run preview + +# pnpm +pnpm run preview + +# yarn +yarn preview + +# bun +bun run preview +``` + +Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information. diff --git a/.docs/[...slug].vue b/.docs/[...slug].vue new file mode 100644 index 0000000..f3b420b --- /dev/null +++ b/.docs/[...slug].vue @@ -0,0 +1,33 @@ + + + diff --git a/.docs/app.config.ts b/.docs/app.config.ts new file mode 100644 index 0000000..9c75bbe --- /dev/null +++ b/.docs/app.config.ts @@ -0,0 +1,192 @@ +export default defineAppConfig({ + ui: { + primary: 'yellow', + gray: 'slate', + avatar: { + default: { + icon: 'i-ph-image', + }, + }, + button: { + default: { + loadingIcon: 'i-ph-spinner', + }, + }, + input: { + default: { + loadingIcon: 'i-ph-spinner', + }, + }, + select: { + default: { + loadingIcon: 'i-ph-spinner', + trailingIcon: 'i-ph-caret-down', + }, + }, + selectMenu: { + default: { + selectedIcon: 'i-ph-check', + }, + }, + notification: { + default: { + closeButton: { + icon: 'i-ph-x', + }, + }, + }, + commandPalette: { + default: { + icon: 'i-ph-magnifying-glass-duotone', + loadingIcon: 'i-ph-spinner', + selectedIcon: 'i-ph-check', + emptyState: { + icon: 'i-ph-magnifying-glass-duotone', + }, + closeButton: { + icon: 'i-ph-x', + }, + }, + }, + table: { + default: { + sortAscIcon: 'i-ph-sort-ascending', + sortDescIcon: 'i-ph-sort-descending', + sortButton: { + icon: 'i-ph-list', + }, + loadingState: { + icon: 'i-ph-spinner', + }, + emptyState: { + icon: 'i-ph-database', + }, + }, + }, + pagination: { + default: { + prevButton: { + icon: 'i-ph-arrow-left', + }, + nextButton: { + icon: 'i-ph-arrow-right', + }, + }, + }, + card: { + rounded: 'rounded-xl', + }, + tooltip: { + background: '!bg-background', + popper: { + strategy: 'absolute', + }, + }, + breadcrumb: { + divider: { + base: 'w-4 h-4', + }, + default: { + divider: 'i-ph-caret-right', + }, + }, + // `@nuxt/ui-pro` specific + variables: { + dark: { + background: 'var(--color-gray-950)', + }, + }, + icons: { + dark: 'i-ph-moon-duotone', + light: 'i-ph-sun-duotone', + search: 'i-ph-magnifying-glass-duotone', + external: 'i-ph-arrow-up-right', + chevron: 'i-ph-caret-down', + hash: 'i-ph-hash-duotone', + }, + header: { + wrapper: 'lg:mb-0 lg:border-0', + links: { + trailingIcon: { + base: 'w-4 h-4', + }, + popover: { + popper: { + strategy: 'absolute', + }, + ui: { + width: 'w-[16rem]', + }, + }, + }, + popover: { + links: { + active: 'dark:bg-gray-950/50', + inactive: 'dark:hover:bg-gray-950/50', + }, + }, + button: { + icon: { + open: 'i-ph-list', + close: 'i-ph-x', + }, + }, + }, + navigation: { + accordion: { + button: { + trailingIcon: { + base: 'w-4 h-4', + }, + }, + }, + }, + page: { + card: { + to: 'dark:hover:bg-gray-900/50', + }, + }, + docs: { + search: { + fileIcon: { + name: 'i-ph-file-text-duotone', + }, + }, + toc: { + button: { + trailingIcon: { + base: 'w-4 h-4', + }, + }, + }, + surround: { + icon: { + prev: 'i-ph-arrow-left', + next: 'i-ph-arrow-right', + }, + }, + }, + content: { + collapsible: { + button: { + icon: { + base: 'w-3 h-3', + }, + }, + }, + prose: { + code: { + button: { + icon: { + copy: 'i-ph-copy-duotone', + copied: 'i-ph-check-square-duotone', + }, + }, + icon: { + terminal: 'i-ph-terminal-window-duotone', + }, + }, + }, + }, + }, +}) diff --git a/.docs/app.vue b/.docs/app.vue new file mode 100644 index 0000000..60fb079 --- /dev/null +++ b/.docs/app.vue @@ -0,0 +1,78 @@ + + + diff --git a/.docs/components/MotionHeader.vue b/.docs/components/MotionHeader.vue new file mode 100644 index 0000000..3d130ca --- /dev/null +++ b/.docs/components/MotionHeader.vue @@ -0,0 +1,55 @@ + + + diff --git a/.docs/components/MotionLogo.vue b/.docs/components/MotionLogo.vue new file mode 100644 index 0000000..02e49ed --- /dev/null +++ b/.docs/components/MotionLogo.vue @@ -0,0 +1,59 @@ + diff --git a/.docs/components/OgImage/OGImagePergel.vue b/.docs/components/OgImage/OGImagePergel.vue new file mode 100644 index 0000000..7253877 --- /dev/null +++ b/.docs/components/OgImage/OGImagePergel.vue @@ -0,0 +1,104 @@ + + + diff --git a/.docs/components/content/ReadMore.vue b/.docs/components/content/ReadMore.vue new file mode 100644 index 0000000..c7c4272 --- /dev/null +++ b/.docs/components/content/ReadMore.vue @@ -0,0 +1,25 @@ + + + + diff --git a/.docs/components/content/YoutubeVideo.vue b/.docs/components/content/YoutubeVideo.vue new file mode 100644 index 0000000..a633bdd --- /dev/null +++ b/.docs/components/content/YoutubeVideo.vue @@ -0,0 +1,19 @@ + + + +