Merge pull request #123 from knowledgecode/develop

docs: migrate documentation site from VitePress to Astro Starlight

Author: knowledgecode

.github/workflows/deploy-docs.yml

@@ -1,11 +1,12 @@
-name: Deploy VitePress site to GitHub Pages
+name: Deploy Starlight site to GitHub Pages
 
 on:
   push:
     branches:
       - master
     paths:
       - 'docs/**'
+      - 'astro.config.mjs'
       - '.github/workflows/deploy-docs.yml'
   workflow_dispatch:
 
@@ -24,13 +25,11 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
 
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 'lts/*'
           cache: npm
 
       - name: Setup Pages
@@ -39,20 +38,23 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
-      - name: Build with VitePress
+      - name: Build with Astro
         run: npm run docs:build
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: docs/.vitepress/dist
+          path: pages
 
   deploy:
     needs: build
     runs-on: ubuntu-latest
     permissions:
       pages: write
       id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
     steps:
       - name: Deploy to GitHub Pages
         id: deployment

.gitignore

@@ -3,4 +3,8 @@
 cache/
 coverage/
 dist/
+pages/
 node_modules/
+
+# Astro
+.astro/

astro.config.mjs

@@ -0,0 +1,88 @@
+import { defineConfig } from 'astro/config';
+import starlight from '@astrojs/starlight';
+
+export default defineConfig({
+  outDir: './pages',
+  srcDir: './docs',
+  site: 'https://knowledgecode.github.io',
+  base: '/date-and-time',
+  trailingSlash: 'never',
+  devToolbar: {
+    enabled: false,
+  },
+  markdown: {
+    shikiConfig: {
+      themes: {
+        light: 'github-light',
+        dark: 'github-dark',
+      },
+    },
+  },
+  integrations: [
+    starlight({
+      customCss: [
+        './docs/styles/custom.css',
+      ],
+      title: 'date-and-time',
+      description: 'The simplest, most intuitive date and time library',
+      logo: {
+        src: './docs/assets/logo.png',
+        alt: 'date-and-time',
+      },
+      social: [
+        { icon: 'github', label: 'GitHub', href: 'https://github.com/knowledgecode/date-and-time' },
+        { icon: 'npm', label: 'npm', href: 'https://www.npmjs.com/package/date-and-time' },
+      ],
+      sidebar: [
+        {
+          label: 'Getting Started',
+          items: [
+            { label: 'Introduction', link: '/guide' },
+            { label: 'Installation', link: '/guide/installation' },
+            { label: 'Quick Start', link: '/guide/quick-start' },
+          ],
+        },
+        {
+          label: 'API Reference',
+          collapsed: true,
+          items: [
+            { label: 'Overview', link: '/api' },
+            {
+              label: 'Core Functions',
+              items: [
+                { label: 'format()', link: '/api/format' },
+                { label: 'parse()', link: '/api/parse' },
+                { label: 'compile()', link: '/api/compile' },
+                { label: 'preparse()', link: '/api/preparse' },
+                { label: 'isValid()', link: '/api/isvalid' },
+                { label: 'transform()', link: '/api/transform' },
+                { label: 'addYears()', link: '/api/addyears' },
+                { label: 'addMonths()', link: '/api/addmonths' },
+                { label: 'addDays()', link: '/api/adddays' },
+                { label: 'addHours()', link: '/api/addhours' },
+                { label: 'addMinutes()', link: '/api/addminutes' },
+                { label: 'addSeconds()', link: '/api/addseconds' },
+                { label: 'addMilliseconds()', link: '/api/addmilliseconds' },
+                { label: 'subtract()', link: '/api/subtract' },
+              ],
+            },
+            {
+              label: 'Utility Functions',
+              items: [
+                { label: 'isLeapYear()', link: '/api/utils/isleapyear' },
+                { label: 'isSameDay()', link: '/api/utils/issameday' },
+                { label: 'getDaysInMonth()', link: '/api/utils/getdaysinmonth' },
+                { label: 'getISOWeekYear()', link: '/api/utils/getisoweekyear' },
+                { label: 'getISOWeek()', link: '/api/utils/getisoweek' },
+              ],
+            },
+          ],
+        },
+        { label: 'Locales', link: '/locales' },
+        { label: 'Timezones', link: '/timezones' },
+        { label: 'Plugins', link: '/plugins' },
+        { label: 'Migration Guide', link: '/migration' },
+      ],
+    }),
+  ],
+});

docs/.vitepress/config.ts

@@ -1,4 +1,6 @@
-# addDays()
+---
+title: addDays()
+---
 
 Adds or subtracts days from a Date object. Handles month boundaries, leap years, and daylight saving time transitions properly.
 

docs/api/addDays.md

@@ -1,4 +1,6 @@
-# addHours()
+---
+title: addHours()
+---
 
 Adds or subtracts hours from a Date object.
 

docs/api/addHours.md

@@ -1,4 +1,6 @@
-# addMilliseconds()
+---
+title: addMilliseconds()
+---
 
 Adds or subtracts milliseconds from a Date object.
 

docs/api/addMilliseconds.md

@@ -1,4 +1,6 @@
-# addMinutes()
+---
+title: addMinutes()
+---
 
 Adds or subtracts minutes from a Date object.
 

docs/api/addMinutes.md

@@ -1,4 +1,6 @@
-# addMonths()
+---
+title: addMonths()
+---
 
 Adds or subtracts months from a Date object. Handles month boundaries, leap years, and varying month lengths appropriately.
 

docs/api/addMonths.md

@@ -1,4 +1,6 @@
-# addSeconds()
+---
+title: addSeconds()
+---
 
 Adds or subtracts seconds from a Date object.