Merge pull request #85 from zunnzunn/chore/73/vitepress-migration

chore: migrated docs to vitepress

.github/workflows/deploy.yml

@@ -0,0 +1,63 @@
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy VitePress site to Pages
+
+on:
+  # Runs on pushes targeting the `main` branch. Change this to `master` if you're
+  # using the `master` branch as the default branch.
+  push:
+    branches: [master]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+      # - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: npm # or pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Install dependencies
+        run: npm ci # or pnpm install / yarn install
+      - name: Build with VitePress
+        run: npm run docs:build # or pnpm docs:build / yarn docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: docs/.vitepress/dist
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

README.md

@@ -16,10 +16,9 @@
 ## Features
 - **[Vue 3](https://v3.vuejs.org/) support**
 - **[TypeScript](https://www.typescriptlang.org/) support** *(ships with out of the box type declarations)*
-- **Interactivity** *(dynamic, moveable, pushable bars with various event handlers)*
--  **Reactivity / Responsiveness** (*bars will be properly repositioned on width resize*)
-- **Customization options** (*chart and bar styling, changes in behavior, slots, event handlers etc.*)
-- **[Day.js](https://day.js.org/en/) support**  *(uses Day.js under the hood for date-time manipulation)*
+- **Interactivity** *(dynamic, movable and pushable bars)*
+- **Reactivity / Responsiveness** (*when changes occur, bars are repositioned accordingly*)
+- **Customization options** (*chart/bar styling, slots, event handlers etc.*)
 
 Using Vue 2? Check out [Vue-Ganttastic v1](https://github.com/zunnzunn/vue-ganttastic/tree/vue-ganttastic-v1).  
 
@@ -119,13 +118,17 @@ For further guides and references, check out the [official docs](https://zunnzun
 **Author**: Marko Žunić, BSc  
 [GitHub Repository](https://github.com/zunnzunn/vue-ganttastic)  
 
-## Donate
+## Support the project!
 In case you found the library useful, a little tip would be much appreciated!
 
-![image](https://user-images.githubusercontent.com/28678851/233090745-a0a6d8a4-6df6-4b82-ac0c-90e69551786e.png)  
-BTC address: bc1qmz4gcewnarl6ldfz78x2htrf7ux6yvl3p2aqje    
-
+<form action="https://www.paypal.com/donate" method="post" target="_top">
+<input type="hidden" name="hosted_button_id" value="M63C8DAMV5YDJ" />
+<input type="image" src="https://pics.paypal.com/00/s/MTdhMWZmNTUtOWQ1Yi00YmRjLWJjMjgtY2Y0NTNhODM0OTJl/file.PNG" border="0" name="submit" title="PayPal - The safer, easier way to pay online!" alt="Donate with PayPal button" style="max-width:200px"/>
+<img alt="" border="0" src="https://www.paypal.com/en_AT/i/scr/pixel.gif" width="1" height="1" />
+</form>
 
+BTC address:  
+![image](https://user-images.githubusercontent.com/28678851/233090745-a0a6d8a4-6df6-4b82-ac0c-90e69551786e.png)  
 
 
 ## Screenshots