init

Author: setcy

.commitlintrc.cjs

@@ -0,0 +1,18 @@
+const fs = require('fs')
+const path = require('path')
+
+const getSubDirectories = (dir) => fs.readdirSync(dir).filter(item => fs.statSync(path.join(dir, item)).isDirectory())
+const corePackages = getSubDirectories(path.resolve(__dirname, 'packages'))
+const ecosystemPackages = getSubDirectories(path.resolve(__dirname, 'ecosystem'))
+
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'scope-enum': [
+      2,
+      'always',
+      [...corePackages, ...ecosystemPackages],
+    ],
+    'footer-max-line-length': [0],
+  },
+}

.editorconfig

@@ -0,0 +1,13 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitattributes

@@ -0,0 +1,10 @@
+* text eol=lf
+*.txt text eol=crlf
+
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.ico binary
+*.tff binary
+*.woff binary
+*.woff2 binary

.gitignore

@@ -0,0 +1,28 @@
+# VuePress files
+docs/.vuepress/.temp/
+docs/.vuepress/.cache/
+docs/.vuepress/dist/
+
+# Dist files
+dist/
+lib/
+
+# Test temp files
+**/__fixtures__/.temp/
+
+# Test coverage files
+coverage/
+
+# Node modules
+node_modules/
+
+# MacOS Desktop Services Store
+.DS_Store
+
+# Log files
+*.log
+
+# Typescript build info
+*.tsbuildinfo
+
+.idea/

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018-present, Yuxi (Evan) You
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,33 @@
+# 杭电助手开发文档
+
+本仓库是杭电助手文档项目，基于[vuepress2](https://v2.vuepress.vuejs.org/zh/)构建。
+
+### 2、本地克隆代码开发
+
+```sh
+git clone [email protected]:hduhelp/open-docs.git
+cd bot-docs
+pnpm install
+pnpm docs:dev
+```
+更多命令请见 [contributing.md](./contributing.md)
+
+## 3.文档结构参考
+
+见 [contributing.md](./contributing.md)
+
+## 参与共建 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+
+- 👏 如果您有针对文档的错误修复，请以分支`fix/xxx`向`main`分支发 PR
+- 👏 如果您有新的内容贡献，请以分支`feature/xxx`向`main`分支发起 PR
+- 👏 如果您有相关的建议或意见，请提[issues](https://github.com/hduhelp/open-docs/issues)
+
+## 贡献者
+
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<a href="https://github.com/hduhelp/open-docs/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=hduhelp/open-docs" />
+</a>
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->

contributing.md

@@ -0,0 +1,109 @@
+---
+sidebar: auto
+---
+
+# 贡献指南
+
+## 概览
+
+项目仓库借助于 [pnpm 工作空间](https://pnpm.io/zh/workspaces) 来实现 [Monorepo](https://en.wikipedia.org/wiki/Monorepo) ，存放了多个互相关联的独立 Package 。
+
+在 `packages` 目录下：
+
+- `bundler-vite`: 基于 Vite 的 Bundler 模块。使用 Vite 对 VuePress App 执行 `dev` 和 `build` 操作。
+- `bundler-webpack`: 基于 Webpack 的 Bundler 模块。使用 Webpack 对 VuePress App 执行 `dev` 和 `build` 操作。
+- `cli`: 命令行接口 (CLI) 模块。包含解析用户配置文件、调用 `@vuepress/core` 创建 VuePress App 、执行对应命令等功能。
+- `client`: Client 模块。包含客户端页面入口，并提供了客户端开发时可以用到的类型和工具函数。
+- `core`: Core 模块。提供 Node API 来创建 VuePress App ，包括页面逻辑、插件系统、数据准备等功能。
+- `markdown`: Markdown 模块。使用 `markdown-it` 作为 Markdown 解析器，并集成了一些 VuePress 中用到的插件。
+- `shared`: 既可以在 Node 端使用、也可以在客户端使用的工具函数模块。
+- `utils`: 仅可以在 Node 端使用的工具函数模块。
+
+在 `ecosystem` 目录下：
+
+- `plugin-${name}`: 官方插件。
+- `theme-default`: 默认主题。
+- `vuepress`: 是 `vuepress-vite` 的封装。
+- `vuepress-vite`: 是 `@vuepress/cli` + `@vuepress/bundler-vite` + `@vuepress/theme-default` 的封装。如果用户想使用 默认主题 + Vite ，仅安装这个 Package 就可以了。
+- `vuepress-webpack`: 是 `@vuepress/cli` + `@vuepress/bundler-webpack` + `@vuepress/theme-default` 的封装。如果用户想使用 默认主题 + Webpack ，仅安装这个 Package 就可以了。
+
+## 开发配置
+
+开发要求：
+
+- [Node.js](http://nodejs.org) **version 14.18.0+**
+- [pnpm](https://pnpm.io/zh/) **version 7+**
+
+克隆代码仓库，并安装依赖：
+
+```bash
+pnpm install
+```
+
+构建源代码：
+
+```bash
+pnpm build
+```
+
+开始开发项目文档网站：
+
+```bash
+pnpm docs:dev
+```
+
+本项目开发使用的一些主要工具：
+
+- [TypeScript](https://www.typescriptlang.org/) 作为开发语言
+- [Vitest](https://vitest.dev/) 用于单元测试
+- [ESLint](https://eslint.org/) + [Prettier](https://prettier.io/) 用于代码检查和格式化
+
+## 开发脚本
+
+### `pnpm build`
+
+`build` 命令会使用 `tsc` 和 `tsup` 将 TypeScript 源文件编译为 JavaScript 文件。
+
+此外，它还会将必要的资源文件从源文件目录复制到输出目录。这是因为一些资源文件不会被 `tsc` 或 `tsup` 处理，但它们仍需要被放置到输出目录，并保持它们的项目对路径不变。
+
+你在克隆代码仓库后，可能需要先执行该命令来确保项目代码可以顺利运行，因为编译后的输出目录被 `.gitignore` 排除在仓库以外了。
+
+### `pnpm clean`
+
+`clean` 命令会执行所有子 Package 中的 `clean` 命令，清除所有的输出文件目录和缓存文件。换言之，它将移除所有通过 `build` 和 `copy` 命令生成的文件。
+
+当你想要从最初状态重新构建源代码时，你可以执行该命令。
+
+### `pnpm dev:*`
+
+`dev:` 前缀表明，这些命令是针对开发使用的，将会以监听模式运行对应的脚本。
+
+### `pnpm docs:*`
+
+#### `pnpm docs:build`, `pnpm docs:dev`, `pnpm docs:clean`
+
+`docs:` 前缀表明，这些命令是针对文档 (documentation) 进行操作的，即 `docs` 目录。
+
+VuePress 使用它自己来构建自己的文档网站。
+
+你需要先执行 `pnpm build` 来构建 VuePress 源代码，然后再运行这些 `docs:` 开头的命令来开发或构建文档。
+
+#### `pnpm docs:serve`
+
+在本地启动文档网站服务器。
+
+你需要先运行 `pnpm docs:build` 来生成文档网站的输出文件，然后再通过该命令来启动文档网站。
+
+### `pnpm lint`
+
+`lint` 命令使用 ESLint 来检查所有源文件。
+
+### `pnpm test`
+
+`test` 命令使用 Vitest 来运行单元测试。
+
+## 文档
+
+VuePress 的文档是由 VuePress 自己驱动的，是由该仓库中的源码构建而来。
+
+所有的 Markdown 源文件都放置在 `docs` 目录下。

docs/.vuepress/components/NpmBadge.vue

@@ -0,0 +1,49 @@
+<script setup lang="ts">
+import { computed } from 'vue'
+
+const props = defineProps({
+  package: {
+    type: String,
+    required: true,
+  },
+  distTag: {
+    type: String,
+    required: false,
+    default: 'next',
+  },
+})
+
+const badgeLink = computed(
+  () => `https://www.npmjs.com/package/${props.package}`
+)
+const badgeLabel = computed(() => {
+  if (props.distTag) {
+    return `${props.package}@${props.distTag}`
+  }
+  return props.package
+})
+const badgeImg = computed(
+  () =>
+    `https://badgen.net/npm/v/${props.package}/${
+      props.distTag
+    }?label=${encodeURIComponent(badgeLabel.value)}`
+)
+</script>
+
+<template>
+  <a
+    class="npm-badge"
+    :href="badgeLink"
+    :title="package"
+    target="_blank"
+    rel="noopener noreferrer"
+  >
+    <img :src="badgeImg" :alt="package" />
+  </a>
+</template>
+
+<style scoped>
+.npm-badge {
+  margin-right: 0.5rem;
+}
+</style>