feat(docs): add github pages using docsify

This commit is contained in:
wohenbushuang
2025-05-09 22:02:36 +00:00
parent 0c5b27d864
commit 416ae4c27f
2 changed files with 230 additions and 0 deletions

57
_sidebar.md Normal file
View File

@@ -0,0 +1,57 @@
- 介绍安装
- [系统介绍](../../README.md)
- [环境搭建](/docs/guide-zh-CN/start-environment.md)
- [系统安装](/docs/guide-zh-CN/start-installation.md)
- [生产部署](/docs/guide-zh-CN/start-deploy.md)
- [如何提问](/docs/guide-zh-CN/start-questions.md)
- [常见问题](/docs/guide-zh-CN/start-issue.md)
- [更新历史](/docs/guide-zh-CN/start-update-log.md)
- 系统开发
- [目录结构](/docs/guide-zh-CN/sys-catalog.md)
- [开发规范](/docs/guide-zh-CN/sys-exploit.md)
- [控制台](/docs/guide-zh-CN/sys-console.md)
- [中间件/拦截器](/docs/guide-zh-CN/sys-middleware.md)
- [WebHook](/docs/guide-zh-CN/sys-webhook.md)
- [权限控制](/docs/guide-zh-CN/sys-auth.md)
- [支付网关](/docs/guide-zh-CN/sys-payment.md)
- [定时任务](/docs/guide-zh-CN/sys-cron.md)
- [消息队列](/docs/guide-zh-CN/sys-queue.md)
- [功能扩展库](/docs/guide-zh-CN/sys-library.md)
- [工具方法](/docs/guide-zh-CN/sys-utility.md)
- [WebSocket服务器](/docs/guide-zh-CN/sys-websocket-server.md)
- [TCP服务器](/docs/guide-zh-CN/sys-tcp-server.md)
- [SaaS多租户](/docs/guide-zh-CN/sys-tenant.md)
- [单元测试](/docs/guide-zh-CN/sys-test.md)
- 插件模块开发
- [模块介绍及目录](/docs/guide-zh-CN/addon-introduce-catalog.md)
- [模块开发流程](/docs/guide-zh-CN/addon-flow.md)
- [模块辅助说明](/docs/guide-zh-CN/addon-helper.md)
- 生成代码
- [使用前提](/docs/guide-zh-CN/code-start.md)
- [数据库](/docs/guide-zh-CN/sys-db.md)
- [生成配置](/docs/guide-zh-CN/code-config.md)
- [生成CURD](/docs/guide-zh-CN/code-curd.md)
- [生成关联表CURD](/docs/guide-zh-CN/code-curd-join.md)
- [生成树型CURD](/docs/guide-zh-CN/code-tree.md)
- [生成业务模板](/docs/guide-zh-CN/code-business.md)
- [生成模板开发](/docs/guide-zh-CN/code-template-dev.md)
- [生成常见问题](/docs/guide-zh-CN/code-help.md)
- 前端开发
- [表单组件](/docs/guide-zh-CN/web-form.md)
- [WebSocket客户端](/docs/guide-zh-CN/sys-websocket-client.md)
- [独立部署](/docs/guide-zh-CN/web-deploy.md)
- 附录
- [网址收录](/docs/guide-zh-CN/append-website.md)

173
index.html Normal file
View File

@@ -0,0 +1,173 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport"
content="width=device-width, initial-scale=1, minimum-scale=1.0, shrink-to-fit=no, viewport-fit=cover">
<!-- Replace with your own title and description. -->
<title>HotGo-V2</title>
<meta name="description" content="基于全新GoFrame2+Vue3+NaiveUI+uniapp开发的全栖框架为二次开发而生适合中小型完整应用开发。">
<!-- Default Theme (see https://docsify.js.org/#/themes) -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
</head>
<body>
<div id="app"></div>
<script>
// Docsify Configuration (see https://docsify.js.org/#/configuration)
window.$docsify = {
name: "HotGo-V2",
nameLink: {
'/docs/guide-zh-CN/': '/',
'/': '/',
},
relativePath: true,
// alias: {
// "/.*/_navbar.md": "/_navbar.md",
// },
// themeColor: "#42b983",
// logo: "https://bufanyun.cn-bj.ufileos.com/hotgo/logo.sig.png",
// coverpage: true,
// homepage: "README.md",
// Sidebar Configuration
auto2top: true,
loadSidebar: true,
// maxLevel: 2,
// Set subMaxLevel to 0 to remove automatic display of page table of contents (TOC) in Sidebar
// subMaxLevel: 3,
// Navbar Configuration
// loadNavbar: true,
// Search Plugin Configuration
search: {
placeholder: {
"/": "搜索",
// "/": "Type to search"
},
noData: {
"/": "找不到结果",
// "/": "No Results"
},
// Headline depth, 1 - 6
// depth: 2,
},
// Flexible-alerts Plugin Configuration
"flexible-alerts": {
important: {
label: "Important",
// localization
label: {
// "/zh-cn": "重要",
"/": "Important"
},
// Assuming that we use Font Awesome
icon: "far fa-message",
className: "important"
},
warning: {
label: "Warning",
// localization
label: {
// "/zh-cn": "警告",
"/": "Warning"
},
// Assuming that we use Font Awesome
icon: "fas fa-triangle-exclamation",
className: "warning"
},
caution: {
label: "Caution",
// localization
label: {
// "/zh-cn": "注意",
"/": "Caution"
},
// Assuming that we use Font Awesome
icon: "fas fa-circle-exclamation",
className: "attention"
},
},
// Hide-code Plugin Configuration
hideCode: {
// scroll: false, // Enable scrolling
height: 300 // Max height
},
// Versioned Plugin Configuration
// versions: [
// { folder: "/", label: "v2", default: true },
// ],
// versionSelectorLabel: "Version",
// Progress Plugin Configuration
progress: {
position: "top",
// color: "var(--theme-color,#42b983)",
height: "3px",
},
};
</script>
<!-- Required -->
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js"></script>
<!-- Recommended -->
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/zoom-image.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.js"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-pagination/dist/docsify-pagination.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-hide-code/dist/docsify-hide-code.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-progress@latest/dist/progress.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-example-panels"></script>
<!-- Prism code highlight -->
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-matlab.min.js"></script>
<!-- docsify-dark-switcher -->
<script src="https://cdn.jsdelivr.net/gh/LIGMATV/docsify-dark-switcher@latest/docsify-dark-switcher.js"></script>
<style>
:root {
--dark-base-background: #222;
--dark-base-color: #bbc0c4;
--dark-theme-color: var(--theme-color, #42b983);
--dark-code-color: var(--dark-color);
--dark-heading-color: var(--dark-theme-color);
--dark-cover-background: #000000a8;
--dark-code-background: #303030;
--dark-tip-background: #2c0000;
--dark-warn-background: #005842;
--dark-icon-size: 25px;
--dark-icon-transition: .1s ease-in-out .1s;
--dark-moon-color: #000000;
--dark-sun-color: #ffffff;
}
</style>
<!-- docsify-plugin-flexible-alerts -->
<script src="https://cdn.jsdelivr.net/npm/docsify-plugin-flexible-alerts/dist/docsify-plugin-flexible-alerts.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free/js/all.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free/css/fontawesome.min.css">
<!-- docsify-versioned-plugin -->
<!-- <script src="https://cdn.jsdelivr.net/npm/docsify-versioned-plugin@0.0.1/index.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-versioned-plugin@0.0.1/styles.css"> -->
</body>
</html>