docs: rearrange pages

brc-dd · Jan 3, 2023 · 480de4f · 480de4f
1 parent b9ec676
commit 480de4f
Show file tree

Hide file tree

Showing 31 changed files with 50 additions and 50 deletions.
diff --git a/.eslintrc.yaml b/.eslintrc.yaml
@@ -20,7 +20,7 @@ parserOptions:
   ecmaVersion: 2019
   project:
     - tsconfig.json
-    - site/tsconfig.json
+    - docs/tsconfig.json
   sourceType: module
 plugins:
   - '@typescript-eslint'

diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml
@@ -27,10 +27,10 @@ jobs:
           node-version: lts/*
           cache: pnpm
       - uses: actions/configure-pages@v1
-      - run: pnpm i && pnpm build && pnpm vitepress build site --base /animated-tailwindcss/
+      - run: pnpm i && pnpm build && pnpm vitepress build docs --base /animated-tailwindcss/
       - uses: actions/upload-pages-artifact@v1
         with:
-          path: site/.vitepress/dist
+          path: docs/.vitepress/dist
 
   deploy:
     environment:

diff --git a/site/.postcssrc.yaml → docs/.postcssrc.yaml b/site/.postcssrc.yaml → docs/.postcssrc.yaml
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -0,0 +1,45 @@
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+  title: 'tw-Animated',
+  description: 'animated-tailwindcss is a package that brings Animate.css classes to Tailwind CSS',
+  cleanUrls: 'without-subfolders',
+
+  themeConfig: {
+    socialLinks: [{ icon: 'github', link: 'https://github.com/brc-dd/animated-tailwindcss' }],
+
+    outline: false,
+
+    sidebar: [
+      {
+        text: 'Guide',
+        items: [
+          { text: 'Getting Started', link: '/installation' },
+          { text: 'Available Animations', link: '/animations' },
+          { text: 'Miscellaneous Notes', link: '/advanced' },
+        ],
+      },
+      {
+        text: 'Available Utilities',
+        items: [
+          { text: 'Animation Delay', link: '/animation-delay' },
+          { text: 'Animation Direction', link: '/animation-direction' },
+          { text: 'Animation Duration', link: '/animation-duration' },
+          { text: 'Animation Fill Mode', link: '/animation-fill-mode' },
+          { text: 'Animation Iteration Count', link: '/animation-iteration-count' },
+          { text: 'Animation Name', link: '/animation-name' },
+          { text: 'Animation Play State', link: '/animation-play-state' },
+          { text: 'Animation Timing Function', link: '/animation-timing-function' },
+          { text: 'Translation Distance', link: '/translation-distance' },
+        ],
+      },
+    ],
+
+    editLink: { pattern: 'https://github.com/brc-dd/animated-tailwindcss/edit/main/docs/:path' },
+
+    footer: {
+      message: 'Released under the MIT License.',
+      copyright: 'Copyright © 2023-present Divyansh Singh',
+    },
+  },
+})
diff --git a/site/.vitepress/theme/Demo.vue → docs/.vitepress/theme/Demo.vue b/site/.vitepress/theme/Demo.vue → docs/.vitepress/theme/Demo.vue
diff --git a/site/.vitepress/theme/Layout.vue → docs/.vitepress/theme/Layout.vue b/site/.vitepress/theme/Layout.vue → docs/.vitepress/theme/Layout.vue
@@ -20,7 +20,7 @@ import './index.css'
         </h1>
         <div class="flex flex-wrap justify-center pt-6">
           <div class="shrink-0 p-1.5">
-            <VPButton text="Get Started" href="/docs/installation" />
+            <VPButton text="Get Started" href="/installation" />
           </div>
           <div class="shrink-0 p-1.5">
             <VPButton

diff --git a/site/.vitepress/theme/index.css → docs/.vitepress/theme/index.css b/site/.vitepress/theme/index.css → docs/.vitepress/theme/index.css
diff --git a/site/.vitepress/theme/index.ts → docs/.vitepress/theme/index.ts b/site/.vitepress/theme/index.ts → docs/.vitepress/theme/index.ts
diff --git a/site/.vitepress/theme/shims.d.ts → docs/.vitepress/theme/shims.d.ts b/site/.vitepress/theme/shims.d.ts → docs/.vitepress/theme/shims.d.ts
diff --git a/site/docs/advanced.md → docs/advanced.md b/site/docs/advanced.md → docs/advanced.md
diff --git a/site/docs/animation-delay.md → docs/animation-delay.md b/site/docs/animation-delay.md → docs/animation-delay.md
diff --git a/site/docs/animation-direction.md → docs/animation-direction.md b/site/docs/animation-direction.md → docs/animation-direction.md
diff --git a/site/docs/animation-duration.md → docs/animation-duration.md b/site/docs/animation-duration.md → docs/animation-duration.md
diff --git a/site/docs/animation-fill-mode.md → docs/animation-fill-mode.md b/site/docs/animation-fill-mode.md → docs/animation-fill-mode.md
diff --git a/site/docs/animation-iteration-count.md → docs/animation-iteration-count.md b/site/docs/animation-iteration-count.md → docs/animation-iteration-count.md
diff --git a/site/docs/animation-name.md → docs/animation-name.md b/site/docs/animation-name.md → docs/animation-name.md
diff --git a/site/docs/animation-play-state.md → docs/animation-play-state.md b/site/docs/animation-play-state.md → docs/animation-play-state.md
diff --git a/site/docs/animation-timing-function.md → docs/animation-timing-function.md b/site/docs/animation-timing-function.md → docs/animation-timing-function.md
diff --git a/site/animations.md → docs/animations.md b/site/animations.md → docs/animations.md
diff --git a/site/index.md → docs/index.md b/site/index.md → docs/index.md
diff --git a/site/docs/installation.md → docs/installation.md b/site/docs/installation.md → docs/installation.md
diff --git a/site/public/animate-css.svg → docs/public/animate-css.svg b/site/public/animate-css.svg → docs/public/animate-css.svg
diff --git a/site/public/commits.svg → docs/public/commits.svg b/site/public/commits.svg → docs/public/commits.svg
diff --git a/site/public/license.svg → docs/public/license.svg b/site/public/license.svg → docs/public/license.svg
diff --git a/site/public/logo-dark.svg → docs/public/logo-dark.svg b/site/public/logo-dark.svg → docs/public/logo-dark.svg
diff --git a/site/public/logo-light.svg → docs/public/logo-light.svg b/site/public/logo-light.svg → docs/public/logo-light.svg
diff --git a/site/public/tailwind-css.svg → docs/public/tailwind-css.svg b/site/public/tailwind-css.svg → docs/public/tailwind-css.svg
diff --git a/site/docs/translation-distance.md → docs/translation-distance.md b/site/docs/translation-distance.md → docs/translation-distance.md
diff --git a/site/tsconfig.json → docs/tsconfig.json b/site/tsconfig.json → docs/tsconfig.json
diff --git a/site/.vitepress/config.ts b/site/.vitepress/config.ts
diff --git a/tailwind.config.cjs b/tailwind.config.cjs
@@ -2,6 +2,6 @@ const { withAnimations } = require('.')
 
 module.exports = withAnimations({
   // prefix: 'tw-',
-  content: ['./site/.vitepress/theme/*.vue'],
+  content: ['./docs/.vitepress/theme/*.vue'],
   safelist: [{ pattern: /animate-.*/ }],
 })