项目上传

2021-07-12 09:48:28 +08:00 · 2021-07-12 09:48:28 +08:00 · de7f8cc96a
commit de7f8cc96a
11 changed files with 25469 additions and 0 deletions
--- a/.gitignore
+++ b/.gitignore
@ -0,0 +1,202 @@
+# ---> VisualStudioCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+.temp
+
+# ---> Vue
+# gitignore template for Vue.js projects
+#
+# Recommended template: Node.gitignore
+
+# TODO: where does this rule come from?
+docs/_book
+
+# TODO: where does this rule come from?
+test/
+
+# ---> 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
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# 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
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# ---> JetBrains
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
--- a/README.md
+++ b/README.md
@ -0,0 +1,12 @@
+# ChinaWeal项目文档模版
+
+项目为基于Vuepress进行预配置的使用模版，请使用者在使用时自行进行复制或派生进行业务定制文档编写。
+
+## 项目示例效果
+
+项目官方项目的预配置模版，具体实现效果可以直接参考[官方文档](https://www.vuepress.cn/guide/)的效果。
+![官方文档截图](http://47.107.61.133:3000/chinaweal/public/raw/branch/master/img/vuepress.png)
+
+## 编写约定与规范
+
+[约定与规范](约定与规范.md)
--- a/docs/.vuepress/config.js
+++ b/docs/.vuepress/config.js
@ -0,0 +1,34 @@
+/**
+ * 配置文档：https://vuepress.vuejs.org/zh/config/
+ */
+const baseContext = '/doc'
+module.exports = {
+    base: baseContext, // url context 举例：当base为/时。应部署在http://domain/下；当base 为/doc时，应部署在http://domain/doc下
+    title: 'Hello VuePress', // 网站title
+    description: 'Just playing around', // 网站<meta>的description
+    header:[
+        ['link', { rel: 'icon', href: baseContext + '/favicon.ico' }]
+    ],
+    port: '8080', // dev环境下的服务端口
+    // locales:{}, // 多语言
+    //shouldPrefetch: () => {}, // 一个函数，用来控制对于哪些文件，是需要生成 <link rel="prefetch"> 资源提示的。请参考https://ssr.vuejs.org/zh/api/#shouldprefetch
+    cache: true, // cache-loader开关
+    extraWatchFiles:[], //指定需要额外监听的重构文件
+    patterns:['**/*.md', '**/*.vue'], //指定需要处理的文件的名称正则
+    plugins:['@vuepress/medium-zoom', '@vuepress/back-to-top','@vuepress/active-header-links'], // 插件https://vuepress.vuejs.org/zh/plugin/using-a-plugin.html,
+    themeConfig: {
+        // 搜索框右侧导航栏
+        nav: [
+            { text: '首页', link: '/' },
+        ],
+        // 侧边导航栏
+        sidebar: [
+            {
+                title:'首页',
+                path:'/'
+            }
+        ],
+        // 文章h2遍历生成深度
+        sidebarDepth: 3
+    }
+}
--- a/docs/.vuepress/enhanceApp.js
+++ b/docs/.vuepress/enhanceApp.js
@ -0,0 +1,16 @@
+/**
+ * 由于 VuePress 是一个标准的 Vue 应用，你可以通过创建一个 .vuepress/enhanceApp.js 文件来做一些应用级别的配置，
+ * 当该文件存在的时候，会被导入到应用内部。enhanceApp.js 应该 export default 一个钩子函数，并接受一个包含了一些应用级别属性的对象作为参数。
+ * 你可以使用这个钩子来安装一些附加的 Vue 插件、注册全局组件，或者增加额外的路由钩子等：
+ * 相关阅读：
+ * <a href="https://vuepress.vuejs.org/zh/plugin/option-api.html#enhanceappfiles">相关阅读</a>
+ */
+export default ({
+    Vue, // VuePress 正在使用的 Vue 构造函数
+    options, // 附加到根实例的一些选项
+    router, // 当前应用的路由实例
+    siteData, // 站点元数据
+    isServer // 当前应用配置是处于 服务端渲染 或 客户端
+  }) => {
+    // ...做一些其他的应用级别的优化
+  }
--- a/docs/.vuepress/public/favicon.ico
+++ b/docs/.vuepress/public/favicon.ico
--- a/docs/.vuepress/styles/index.styl
+++ b/docs/.vuepress/styles/index.styl
@ -0,0 +1,4 @@
+// 额外全局样式
+// .content {
+//   font-size 30px
+// }
--- a/docs/.vuepress/styles/palette.styl
+++ b/docs/.vuepress/styles/palette.styl
@ -0,0 +1,20 @@
+// 颜色
+$accentColor = #3eaf7c
+$textColor = #2c3e50
+$borderColor = #eaecef
+$codeBgColor = #282c34
+$arrowBgColor = #ccc
+$badgeTipColor = #42b983
+$badgeWarningColor = darken(#ffe564, 35%)
+$badgeErrorColor = #DA5961
+
+// 布局
+$navbarHeight = 3.6rem
+$sidebarWidth = 20rem
+$contentWidth = 740px
+$homePageWidth = 960px
+
+// 响应式变化点
+$MQNarrow = 959px
+$MQMobile = 719px
+$MQMobileNarrow = 419px
--- a/docs/README.md
+++ b/docs/README.md
@ -0,0 +1 @@
+# Hello VuePress
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@ -0,0 +1,23 @@
+{
+  "name": "crgs-project-doc",
+  "version": "1.0.0",
+  "description": "广州市局综合监管项目文档",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "dev": "vuepress dev docs --temp .temp",
+    "build": "vuepress build docs"
+  },
+  "repository": {
+    "type": "git",
+    "url": "http://47.107.61.133:3000/crgs-project/crgs-project-doc.git"
+  },
+  "author": "lroyia",
+  "license": "ISC",
+  "devDependencies": {
+    "@vuepress/plugin-active-header-links": "^1.8.2",
+    "@vuepress/plugin-back-to-top": "^1.8.2",
+    "@vuepress/plugin-medium-zoom": "^1.8.2",
+    "vuepress": "^1.8.2"
+  }
+}
--- a/约定与规范.md
+++ b/约定与规范.md
@ -0,0 +1,74 @@
+# 约定与规范
+
+> 开发铁则`“约定优于配置”`，请秉承`“约定优于配置”`铁则，严格按照规范进行开发以便后续维护
+
+## VuePress默认“约定”
+
+### 目录结构
+
+VuePress 遵循 “约定优于配置” 的原则，推荐的目录结构如下：
+
+```
+.
+├── docs
+│   ├── .vuepress (可选的)
+│   │   ├── components (可选的)
+│   │   ├── theme (可选的)
+│   │   │   └── Layout.vue
+│   │   ├── public (可选的)
+│   │   ├── styles (可选的)
+│   │   │   ├── index.styl
+│   │   │   └── palette.styl
+│   │   ├── templates (可选的, 谨慎配置)
+│   │   │   ├── dev.html
+│   │   │   └── ssr.html
+│   │   ├── config.js (可选的)
+│   │   └── enhanceApp.js (可选的)
+│   │ 
+│   ├── README.md
+│   ├── guide
+│   │   └── README.md
+│   └── config.md
+│ 
+└── package.json
+```
+
+> 注意:  
+请留意目录名的大写。
+
+- `docs/.vuepress`: 用于存放全局的配置、组件、静态资源等。
+- `docs/.vuepress/components`: 该目录中的 Vue 组件将会被自动注册为全局组件。
+- `docs/.vuepress/theme`: 用于存放本地主题。
+- `docs/.vuepress/styles`: 用于存放样式相关的文件。
+- `docs/.vuepress/styles/index.styl`: 将会被自动应用的全局样式文件，会生成在最终的 CSS 文件结尾，具有比默认样式更高的优先级。
+- `docs/.vuepress/styles/palette.styl`: 用于重写默认颜色常量，或者设置新的 stylus 颜色常量。
+- `docs/.vuepress/public`: 静态资源目录。
+- `docs/.vuepress/templates`: 存储 HTML 模板文件。
+- `docs/.vuepress/templates/dev.html`: 用于开发环境的 HTML 模板文件。
+- `docs/.vuepress/templates/ssr.html`: 构建时基于 Vue SSR 的 HTML 模板文件。
+- `docs/.vuepress/config.js`: 配置文件的入口文件，也可以是 YML 或 toml。
+- `docs/.vuepress/enhanceApp.js`: 客户端应用的增强。
+
+> 注意  
+当你想要去自定义`templates/ssr.html`或`templates/dev.html`时，最好基于[默认的模板文件](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/client/index.dev.html)来修改，否则可能会导致构建出错。
+
+### 默认的页面路由
+
+此处我们把`docs`目录作为`targetDir`（参考 命令行接口），下面所有的“文件的相对路径”都是相对于`docs`目录的。在项目根目录下的`package.json`中添加`scripts`：
+
+```json
+{
+  "scripts": {
+    "dev": "vuepress dev docs",
+    "build": "vuepress build docs"
+  }
+}
+```
+
+对于上述的目录结构，默认页面路由地址如下：
+
+|文件的相对路径|页面路由地址|
+|---|---|
+|/README.md|/|
+|/guide/README.md|/guide/|
+|/config.md|/config.html|