Release 1.4.2 (#15)

Author: hywax

.github/workflows/docs.yml

@@ -0,0 +1,54 @@
+name: Deploy Documentation site to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Install dependencies
+        run: yarn install
+      - name: Build with VitePress
+        run: |
+          yarn docs:build
+          touch docs/.vitepress/dist/.nojekyll
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: docs/.vitepress/dist
+
+  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

.github/workflows/release.yml

@@ -2,6 +2,11 @@
 
 All notable changes to this project will be documented in this file.
 
+## v1.4.2
+
+- Update deps
+- Migrate docs to vitepress
+
 ## v1.4.1
 
 - Update deps

CHANGELOG.md

@@ -19,6 +19,7 @@ A Nuxt module for cron jobs in your app.
 - 🕔️  Time zone support
 - 🪄️  TypeScript support
 - ✨  Auto imports enabled
+- ⚡  Zero configuration to start
 - 📦  Extendable by [Nuxt modules](https://nuxt.com/modules)
 
 ## Installation
@@ -83,16 +84,9 @@ or use with params:
 // server/cron/job.ts
 import { defineCronHandler } from '#nuxt/cron'
 
-export default defineCronHandler(
-  'everySecond',
-  () => {
-    console.log('I run every seconds')
-  },
-  {
-    runOnInit: true,
-    timeZone: 'Africa/Abidjan'
-  }
-)
+export default defineCronHandler('everySecond', () => {
+  console.log('I run every seconds')
+}, { runOnInit: true })
 ```
 
 <!-- Badges -->

README.md

@@ -1,12 +1,2 @@
-node_modules
-*.iml
-.idea
-*.log*
-.nuxt
-.vscode
-.DS_Store
-coverage
-dist
-sw.*
-.env
-.output
+.vitepress/cache
+.vitepress/dist

docs/.editorconfig

@@ -0,0 +1,30 @@
+<template>
+  <div class="sandbox" :style="{ height }">
+    <iframe :src="src" sandbox="allow-modals allow-forms allow-popups allow-scripts allow-same-origin" />
+  </div>
+</template>
+
+<script lang="ts" setup>
+import { withDefaults } from 'vue'
+
+withDefaults(defineProps<{ src: string, height: string }>(), {
+  height: '700px',
+})
+</script>
+
+<style scoped>
+.sandbox {
+  overflow: hidden;
+  width: 100%;
+  background-color: var(--vp-c-default-soft);
+  border: 1px solid var(--vp-input-border-color);
+  border-radius: 20px;
+  margin: 16px 0;
+}
+.sandbox iframe {
+  overflow: hidden;
+  width: 100%;
+  height: 100%;
+  border: 0;
+}
+</style>