Merge pull request #94 from leafsphp/beta

New Leaf Documentation

.editorconfig

@@ -5,6 +5,7 @@ indent_size = 2
 end_of_line = lf
 insert_final_newline = true
 trim_trailing_whitespace = true
+quote_type = single
 
 [*.md]
 trim_trailing_whitespace = false

.gitignore

@@ -1,113 +1,14 @@
-### OSX ###
-# General
 .DS_Store
-.AppleDouble
-.LSOverride
 
-# Thumbnails
-._*
+.vitepress/dist
+.vitepress/cache
 
-# Files that might appear in the root of a volume
-.DocumentRevisions-V100
-.fseventsd
-.Spotlight-V100
-.TemporaryItems
-.Trashes
-.VolumeIcon.icns
-.com.apple.timemachine.donotpresent
+old/
 
-# Directories potentially created on remote AFP share
-.AppleDB
-.AppleDesktop
-Network Trash Folder
-Temporary Items
-.apdisk
-
-### Node ###
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
 node_modules/
-jspm_packages/
-
-# TypeScript v1 declaration files
-typings/
-
-# TypeScript cache
-*.tsbuildinfo
+vendor/
 
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# pnpm link folder
-pnpm-global
-
-# dotenv environment variables file
-.env
-.env.test
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
+logs/
+*.log
 
-# rollup.js default build output
 dist/
-
-# vuepress build output
-.vuepress/dist
-
-# Serverless directories
-.serverless/
-
-# Temporary folders
-tmp/
-temp/
-TODOs.md
-src/api/index.json
-src/examples/data.json
-src/tutorial/data.json
-draft.md
-
-.idea/

.vitepress/config.mts

@@ -0,0 +1,85 @@
+import { defineConfig } from 'vitepress';
+import {
+  groupIconMdPlugin,
+  groupIconVitePlugin,
+} from 'vitepress-plugin-group-icons';
+
+import head from './config/head';
+import nav from './config/navbar';
+import sidebar from './config/sidebar';
+
+export default defineConfig({
+  head,
+  lang: 'en-US',
+  srcDir: 'src',
+  scrollOffset: 'header',
+  srcExclude: ['tutorial/**/description.md'],
+
+  title: 'Leaf PHP',
+  description: 'Simple and elegant PHP',
+
+  themeConfig: {
+    nav,
+    sidebar,
+
+    logo: '/logo-circle.png',
+    siteTitle: 'Leaf PHP',
+
+    search: {
+      provider: 'local',
+      // provider: 'algolia',
+      // options: {
+      //   appId: 'Q38TT8XUN9',
+      //   indexName: 'leafphp',
+      //   apiKey: '87b4b8d90960f7a326dfd4c8781a5a74',
+      // },
+    },
+
+    socialLinks: [
+      // { icon: 'languages', link: '/translations/' },
+      { icon: 'github', link: 'https://github.com/vuejs/vitepress' },
+      { icon: 'twitter', link: 'https://x.com/leafphp' },
+      { icon: 'discord', link: 'https://discord.gg/Pkrm9NJPE3' },
+      // {
+      //   icon: 'youtube',
+      //   link: 'https://www.youtube.com/channel/UCllE-GsYy10RkxBUK0HIffw'
+      // }
+    ],
+
+    lastUpdated: {
+      text: 'Updated at',
+      formatOptions: {
+        dateStyle: 'full',
+        timeStyle: 'medium',
+      },
+    },
+
+    editLink: {
+      text: 'Edit this page on GitHub',
+      // pattern: 'https://github.com/leafsphp/docs/edit/next/src/:path',
+      pattern: ({ filePath }) => {
+        if (filePath.startsWith('packages/')) {
+          return `https://github.com/leafsphp/docs/edit/next/src/${filePath}`;
+        } else {
+          return `https://github.com/leafsphp/docs/edit/next/src/${filePath}`;
+        }
+      },
+    },
+
+    footer: {
+      message: `Released under the <a href="https://github.com/leafsphp/leaf/blob/v3.x/LICENSE">MIT License</a>.`,
+      copyright: `Copyright © 2019-${new Date().getFullYear()} Michael Darko-Duodu`,
+    },
+  },
+
+  markdown: {
+    lineNumbers: true,
+    config(md) {
+      md.use(groupIconMdPlugin);
+    },
+  },
+
+  vite: {
+    plugins: [groupIconVitePlugin()],
+  },
+});