diff --git a/README.md b/README.md index b6044cb..f33060c 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ touch docs/get-started.md ### 将你的文档添加到菜单栏 -打开 `site/config.js` 文件,修改 export 的对象即可。比如, +打开 `site.config.js` 文件,修改 export 的对象即可。比如, ```js module.exports = { diff --git a/docs/vue-next/develop-rules.md b/docs/vue-next/develop-rules.md index 85c0e2d..871a021 100644 --- a/docs/vue-next/develop-rules.md +++ b/docs/vue-next/develop-rules.md @@ -3,7 +3,7 @@ title: 开发规范 spline: explain --- -为了维护项目的代码质量,项目中内置了格式化代码的工具 `Prettier` 和代码检测质量检查工具 `ESlint`。 +为了维护项目的代码质量,项目中内置了格式化代码的工具 `Prettier` 和代码检测质量检查工具 `ESLint`。 同时,也推荐您在开发过程中遵循提交规范,以保持项目仓库的分支、提交信息的清晰整洁。 @@ -15,14 +15,16 @@ spline: explain 在脚手架搭建好的项目中,已经内置了符合 TDesign 开发规范的 `.prettierrc.js` 文件。您只需要安装 `Prettier` 插件,即可使用代码自动格式化的功能。 -#### [ESlint](https://eslint.org/) +#### [ESLint](https://eslint.org/) -`ESlint`可以用来检查代码质量和风格问题。 +`ESLint`可以用来检查代码质量和风格问题。 在脚手架搭建好的项目中,也已经内置了 `.eslintrc` 文件。您可以通过下面命令来进行代码检查和自动修复。 执行以下指令,会进行问题的检查及修复,在 pre-commit 的 git hook 中,项目也内置了检查指令,帮助您在提交代码前发现问题。 +**tips: 在 0.13+ 开始, 项目中的相关配置文件已变更为 `eslint.config.js` 内置的规则写法也变更为扁平化配置法,详情请看 [新的默认配置格式](https://eslint.org.cn/docs/latest/use/migrate-to-9.0.0#flat-config)** + ```bash # 代码检查 npm run lint @@ -69,4 +71,4 @@ npm run lint:fix 同时,当项目是协同开发时,推荐在项目中或者在持续集成的过程中,配置 [commit-lint](https://github.com/conventional-changelog/commitlint) 做 commit message 的检查,以约束协同开发者的 commit 遵守规范。 -**tips:如果不熟悉 Conventional Commits 的规范,可以使用 [commitizen](https://github.com/commitizen/cz-cli) 小工具来辅助生成 commit message。** +**tips: 如果不熟悉 Conventional Commits 的规范,可以使用 [commitizen](https://github.com/commitizen/cz-cli) 小工具来辅助生成 commit message。** diff --git a/docs/vue-next/develop.md b/docs/vue-next/develop.md index 0a64f6c..e28562b 100644 --- a/docs/vue-next/develop.md +++ b/docs/vue-next/develop.md @@ -10,21 +10,22 @@ spline: explain ```bash . ├── README.md # 说明文档 -├── index.html # 主 html 文件 +├── index.html # 主入口文件 (HTML) ├── docs -├── mock # mock 目录 +├── mock # Mock 目录 │ └── index.ts ├── package.json ├── package-lock.json -├── node_modules # 项目依赖 +├── node_modules # 项目相关依赖 ├── public │ └── favicon.ico ├── src # 页面代码 ├── .env # 生产环境变量 ├── .env.development # 开发环境变量 -├── commitlint.config.js # commintlint 规范 -├── tsconfig.json # typescript 配置文件 -└── vite.config.js # vite 配置文件 +├── commitlint.config.js # Commintlint 规范 +├── eslint.config.js # ESLint 规范 +├── tsconfig.json # TypeScript 配置文件 +└── vite.config.js # Vite 配置文件 ``` ### 页面代码结构 @@ -82,7 +83,7 @@ src │ ├── font-family.less # 字体文件(腾讯体W7) │ ├── layout.less # 全局样式布局 │ ├── reset.less # 对默认样式的重置 -│ └── variables.less # 模板样式 token +│ └── variables.less # 模板样式 Token ├── types # 类型文件目录 └── utils # 工具层 │ ├── route # 路由工具封装 @@ -97,7 +98,7 @@ src ### 环境变量 在项目的根目录,有 `.env` 配置文件,项目会根据启动的命令中的 `mode` 参数,加载指定的配置文件的配置来运行, -如本地环境执行 `npm run dev`,因为对于命令中的`mode` 参数为`development`,项目运行会加载`.env.development`的配置来运行。 +如本地环境执行 `npm run dev`,因为对于命令中的 `mode` 参数为 `development`,项目运行会加载 `.env.development` 的配置来运行。 项目初始化内置了 `.env.development`、`.env.test` 和 `.env` 分别对应本地开发环境、测试环境 和 生产(正式)环境,也可以根据实际需求继续扩展。 #### 内置的环境变量 @@ -127,9 +128,10 @@ Options API 示例
- index.vue示例 + index.vue 示例
+ + ``` -**tips: 一般情况下推荐您使用`Composition API`进行开发,`Composition API`有关的好处请[点击此处](https://vuejs.org/guide/introduction.html#api-styles)** +**tips: 一般情况下推荐您使用 `Composition API` 进行开发,`Composition API` 有关的好处请 [点击此处](https://vuejs.org/guide/introduction.html#api-styles)** -然后,需要在配置新页面的路由。根据具体的需求,修改 `src/router/modules` 中的文件。 +然后,需要在配置新页面的路由。根据具体的需求,修改 `./src/router/modules` 中的文件。 ```javascript export default [ @@ -208,15 +213,15 @@ export default [ 菜单(侧边栏和面包屑)由路由配置自动生成,根据路由变化可自动匹配,开发者无需手动处理这些逻辑。 -**tip:如果您对 vue 的开发方式不是很熟悉,可以查阅 [新手知识](https://vuejs.org/)。** +**tip:如果您对 Vue 的开发方式不是很熟悉,可以查阅 [新手知识](https://vuejs.org/)。** #### 开发组件 -当 TDesign 提供的组件不能满足您的需求的时候,您可以根据需要开发新的组件, 推荐放置在`src/component`目录下。 +当 TDesign 提供的组件不能满足您的需求的时候,您可以根据需要开发新的组件, 推荐放置在 `./src/component` 目录下。 组件的开发方式和 **页面组件** 的开发方式类似,不过您不再需要去为它增加路由,而是在您的组件中引用即可。 -首先,在 `src/components` 下新增一个组件文件,`new-component.vue` +首先,在 `./src/components` 下新增一个组件文件,`new-component.vue` ```vue @@ -238,10 +243,11 @@ Options API 示例
个人中心 - +
+ +