feat: add docs

docs/.vitepress/config.ts

@@ -6,6 +6,10 @@ import { zh } from './zh'
 export default defineConfig({
   title: "Chinese Days",
 
+  head: [
+    ['link', { rel: 'icon', type: 'image/png', href: '/icon.png' }],
+  ],
+
   rewrites: {
     'zh/:rest*': ':rest*'
   },
@@ -17,5 +21,5 @@ export default defineConfig({
   locales: {
     root: { label: '简体中文', ...zh },
     en: { label: 'English', ...en },
-  }
+  },
 })

docs/.vitepress/en.ts

@@ -1,40 +1,27 @@
 import { createRequire } from 'module'
-import { defineConfig } from 'vitepress'
+import { DefaultTheme, defineConfig } from 'vitepress'
 
 const require = createRequire(import.meta.url)
 const pkg = require('chinese-days/package.json')
 
 export const en = defineConfig({
   description: "A VitePress Site",
+
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     nav: [
-      { text: 'Guide', link: '/en/getting-started' },
-      { text: 'Calendar', link: '/en/calendar' },
+      { text: 'Guide', link: '/en/guide/getting-started' },
+      { text: 'Calendar', link: '/en/demo/calendar' },
       {
         text: pkg.version,
-        items: [
-          {
-            text: 'Changelog',
-            link: 'https://github.com/vsme/chinese-days/blob/main/CHANGELOG.md'
-          },
-          {
-            text: 'Contributing',
-            link: 'https://github.com/vsme/chinese-days?tab=readme-ov-file#%E8%B4%A1%E7%8C%AE%E4%BB%A3%E7%A0%81'
-          }
-        ]
+        link: 'https://github.com/vsme/chinese-days/blob/main/CHANGELOG.md'
       },
     ],
 
-    sidebar: [
-      {
-        text: 'Examples',
-        items: [
-          { text: 'Markdown Examples', link: '/markdown-examples' },
-          { text: 'Runtime API Examples', link: '/api-examples' }
-        ]
-      }
-    ],
+    sidebar: {
+      '/en/guide/': { base: '/en/guide/', items: sidebarGuide() },
+      '/en/demo/': { base: '/en/demo/', items: sidebarDemo() }
+    },
 
     socialLinks: [
       { icon: 'github', link: 'https://github.com/vsme/chinese-days' }
@@ -45,4 +32,58 @@ export const en = defineConfig({
       copyright: 'Copyright © 2024-present Yawei Sun'
     },
   }
-})
+})
+
+function sidebarGuide(): DefaultTheme.SidebarItem[] {
+  return [
+    {
+      text: 'Introduction',
+      collapsed: false,
+      items: [
+        { text: 'What is Chinese Days', link: 'what-is-chinese-days' },
+        { text: 'Getting started', link: 'getting-started' },
+      ]
+    },
+    {
+      text: 'Holidays',
+      collapsed: false,
+      items: [
+        { text: 'Holidays', link: 'holidays' },
+        { text: 'Lieu Days', link: 'lieu-days' },
+        { text: 'Working Days', link: 'working-days' },
+      ]
+    },
+    {
+      text: '24 Solar Terms',
+      collapsed: false,
+      items: [
+        { text: 'Apis', link: '24-solar-terms' },
+      ]
+    },
+    {
+      text: 'Lunar',
+      collapsed: false,
+      items: [
+        { text: 'Solar to Lunar', link: 'to-lunar' },
+        { text: 'Lunar to Solar', link: 'from-lunar' }
+      ]
+    },
+    { text: 'Contributing',
+      collapsed: false,
+      items: [
+        { text: 'Improve together', link: 'contributing' }
+      ]
+    }
+  ]
+}
+
+function sidebarDemo(): DefaultTheme.SidebarItem[] {
+  return [
+    {
+      text: 'Demo',
+      items: [
+        { text: 'Calendar', link: 'calendar' }
+      ]
+    }
+  ]
+}

docs/.vitepress/zh.ts

@@ -1,5 +1,5 @@
 import { createRequire } from 'module'
-import { defineConfig } from 'vitepress'
+import { DefaultTheme, defineConfig } from 'vitepress'
 
 const require = createRequire(import.meta.url)
 const pkg = require('chinese-days/package.json')
@@ -10,32 +10,18 @@ export const zh = defineConfig({
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     nav: [
-      { text: '指南', link: '/getting-started' },
-      { text: '日历', link: '/calendar' },
+      { text: '指南', link: '/guide/getting-started' },
+      { text: '日历', link: '/demo/calendar' },
       {
         text: pkg.version,
-        items: [
-          {
-            text: '更新日志',
-            link: 'https://github.com/vsme/chinese-days/blob/main/CHANGELOG.md'
-          },
-          {
-            text: '参与贡献',
-            link: 'https://github.com/vsme/chinese-days?tab=readme-ov-file#%E8%B4%A1%E7%8C%AE%E4%BB%A3%E7%A0%81'
-          }
-        ]
+        link: 'https://github.com/vsme/chinese-days/blob/main/CHANGELOG.md'
       },
     ],
 
-    sidebar: [
-      {
-        text: 'Examples',
-        items: [
-          { text: 'Markdown Examples', link: '/markdown-examples' },
-          { text: 'Runtime API Examples', link: '/api-examples' }
-        ]
-      }
-    ],
+    sidebar: {
+      '/guide/': { base: '/guide/', items: sidebarGuide() },
+      '/demo/': { base: '/demo/', items: sidebarDemo() }
+    },
 
     socialLinks: [
       { icon: 'github', link: 'https://github.com/vsme/chinese-days' }
@@ -70,4 +56,58 @@ export const zh = defineConfig({
     lightModeSwitchTitle: '切换到浅色模式',
     darkModeSwitchTitle: '切换到深色模式'
   }
-})
+})
+
+function sidebarGuide(): DefaultTheme.SidebarItem[] {
+  return [
+    {
+      text: '简介',
+      collapsed: false,
+      items: [
+        { text: 'Chinese Days', link: 'what-is-chinese-days' },
+        { text: '快速开始', link: 'getting-started' },
+      ]
+    },
+    {
+      text: '节假日',
+      collapsed: false,
+      items: [
+        { text: '节假日', link: 'holidays' },
+        { text: '调休日', link: 'lieu-days' },
+        { text: '工作日', link: 'working-days' },
+      ]
+    },
+    {
+      text: '24节气',
+      collapsed: false,
+      items: [
+        { text: '使用方法', link: '24-solar-terms' },
+      ]
+    },
+    {
+      text: '阴历/农历',
+      collapsed: false,
+      items: [
+        { text: '阳历转农历', link: 'to-lunar' },
+        { text: '农历转阳历', link: 'from-lunar' }
+      ]
+    },
+    { text: '贡献指南',
+      collapsed: false,
+      items: [
+        { text: '一起来完善', link: 'contributing' }
+      ]
+    }
+  ]
+}
+
+function sidebarDemo(): DefaultTheme.SidebarItem[] {
+  return [
+    {
+      text: '使用示例',
+      items: [
+        { text: '日历', link: 'calendar' }
+      ]
+    }
+  ]
+}

docs/en/index.md

@@ -9,10 +9,10 @@ hero:
   actions:
     - theme: brand
       text: Quickstart
-      link: /getting-started
+      link: /en/guide/getting-started
     - theme: alt
       text: View Calendar
-      link: /calendar
+      link: /en/demo/calendar
     - theme: alt
       text: GitHub
       link: https://github.com/vsme/chinese-days

docs/zh/index.md

@@ -9,10 +9,10 @@ hero:
   actions:
     - theme: brand
       text: 快速开始
-      link: /getting-started
+      link: /guide/getting-started
     - theme: alt
       text: 查看日历
-      link: /calendar
+      link: /demo/calendar
     - theme: alt
       text: GitHub
       link: https://github.com/vsme/chinese-days