Skip to content

Commit bcfbd58

Browse files
更新常用CSS样式等
1 parent 1c52936 commit bcfbd58

8 files changed

Lines changed: 133 additions & 114 deletions

README.md

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -21,37 +21,32 @@
2121
- **热重载**:CSS 和 JS 文件进行保存时会自动更新浏览器中的网页。
2222
- 建议打开浏览器「开发者工具」-「网络」-「停用缓存」功能。
2323
- **快速启动**:在 `Visual Studio Code` 中,按 `F5` 可立即启动项目(编译、打开浏览器、热重载)。
24-
- **暗色模式和响应式布局**:CSS 中带有系统暗色模式跟随和响应式布局的示例代码
24+
- **暗色模式和响应式布局**:CSS 中带有很多常用代码结构,包括系统暗色模式跟随和响应式布局
2525
- **ES6**:目前几乎所有主流浏览器已经支持 ES6 ,因此默认使用新一些的 ES6 标准。如果面向低版本浏览器用户可以自行改回 ES5 。
2626
- 可以通过 [前端兼容性检查器](https://github.com/miyabi-project/frontend-compatibility-checker) 为用户提供一个降级跳转。
2727
- **调试网页服务器配置优化**:调试服务器自动添加关闭跨域和缓存的请求头
2828

29-
### 代码格式
29+
## 可用 npm run 命令
3030

31-
详见 `.editorconfig`
32-
33-
- 通用
34-
- `end_of_line = lf`: unix 风格的换行符
35-
- `insert_final_newline = true`: 每个文件都以换行符结尾
36-
- `indent_style = space`: 使用空格缩进
37-
- `charset = utf-8`: 编码格式统一 utf-8
38-
- `indent_size = 2`: 2 个空格缩进
39-
- HTML
40-
- `indent_size = 4`: 4 个空格缩进
41-
- BAT
42-
- `charset = ansi`: ANSI 编码
43-
- `end_of_line = crlf`: windows 风格的换行符
44-
- `indent_size = 4`: 4 个空格缩进
31+
- `npm run build`: 进行测试环境的生成。
32+
- `npm run release`: 进行生产环境的生成。
33+
- `npm run serve`: 进行测试环境的调试,打开浏览器并热更新网页。
34+
- `npm run debug`: 同上,但单独启动热更新和网页服务器。在 Windows 系统中应使用 `debug.bat` 启动。
35+
- `npm run watch`: 仅进行热更新,不打开网页服务器和浏览器。
36+
- `npm run clean`: 清理生成的文件。`release``serve` 会自动执行此步骤,其他需自行运行。
4537

46-
### 编码环境
47-
48-
本模板在以下环境下开发并针对以下环境进行优化。
38+
## 使用
4939

50-
- 编辑器: `Visual Studio Code`
51-
- 推荐插件:
52-
- `EditorConfig for VS Code`: 使 `.editorconfig` 配置生效。
53-
- `Prettier - Code formatter`: 设置为 ts 的默认格式化插件。
54-
- 浏览器: `Google Chrome`
40+
1. 使用 Github 的通过模板创建功能,或者自行下载 zip 来创建自己的仓库。
41+
2. 修改 `package.json` 中所有的项目信息和版权信息为自己的。
42+
3. 修改 `README.md``LICENCE` 为自己的。
43+
4. 执行 `npm i` 下载第三方库。
44+
5.`src/images` 中存放你的多媒体素材。
45+
6. 打开 `src/html/index.html` 编辑网页结构。
46+
7. 打开 `src/css/style.css` 编辑 CSS 样式。
47+
8. 打开 `src/main.ts` 编辑代码。
48+
9. 执行 `npm run serve` 启动项目。
49+
10. 将生成好的网页 `index.html``dist` 文件夹一起复制到网页服务器。
5550

5651
## 注意事项
5752

@@ -67,35 +62,40 @@
6762
- `*.ts`: TS 源代码
6863
- `index.html`: 生成好的网页
6964

70-
## 使用
65+
## 编码环境
7166

72-
1. 使用 Github 的通过模板创建功能,或者自行下载 zip 来创建自己的仓库。
73-
2. 修改 `package.json` 中所有的项目信息和版权信息为自己的。
74-
3. 修改 `README.md``LICENCE` 为自己的。
75-
4. 执行 `npm i` 下载第三方库。
76-
5.`src/images` 中存放你的多媒体素材。
77-
6. 打开 `src/html/index.html` 编辑网页结构。
78-
7. 打开 `src/css/style.css` 编辑 CSS 样式。
79-
8. 打开 `src/main.ts` 编辑代码。
80-
9. 执行 `npm run serve` 启动项目。
81-
10. 将生成好的网页 `index.html``dist` 文件夹一起复制到网页服务器。
67+
本模板在以下环境下开发并针对以下环境进行优化。
68+
69+
- 编辑器: `Visual Studio Code`
70+
- 推荐插件:
71+
- `EditorConfig for VS Code`: 使 `.editorconfig` 配置生效。
72+
- `Prettier - Code formatter`: 设置为 ts 的默认格式化插件。
73+
- 浏览器: `Google Chrome`
8274

83-
### 可用 NPM 脚本
75+
## 代码格式
76+
77+
详见 `.editorconfig`
8478

85-
- `build`: 进行测试环境的生成。
86-
- `release`: 进行生产环境的生成。
87-
- `serve`: 进行测试环境的调试,打开浏览器并热更新网页。
88-
- `debug`: 同上,但单独启动热更新和网页服务器。在 Windows 系统中应使用 `debug.bat` 启动。
89-
- `watch`: 仅进行热更新,不打开网页服务器和浏览器。
90-
- `clean`: 清理生成的文件。`release``serve` 会自动执行此步骤,其他需自行运行。
79+
- 通用
80+
- `end_of_line = lf`: unix 风格的换行符
81+
- `insert_final_newline = true`: 每个文件都以换行符结尾
82+
- `indent_style = space`: 使用空格缩进
83+
- `charset = utf-8`: 编码格式统一 utf-8
84+
- `indent_size = 2`: 2 个空格缩进
85+
- HTML
86+
- `indent_size = 4`: 4 个空格缩进
87+
- BAT
88+
- `charset = ansi`: ANSI 编码
89+
- `end_of_line = crlf`: windows 风格的换行符
90+
- `indent_size = 4`: 4 个空格缩进
9191

92-
## 部分构造细节
92+
## 初始化内容
9393

9494
- `npm install --save-dev typescript ts-loader webpack webpack-cli http-server webpack-dev-server html-webpack-plugin css-loader mini-css-extract-plugin css-minimizer-webpack-plugin terser-webpack-plugin`
9595
- `./node_modules/typescript/bin/tsc --init`
9696

9797
## 协议
9898

99-
- 根据本模板创建的项目可以自由变更许可协议,请尽快将作者信息、项目信息、许可信息改为自己的。
99+
- 根据本模板创建的项目可以自由变更许可协议, **请尽快将作者信息、项目信息、许可信息改为自己的。**
100100

101101
Copyright (c) 2022 KagurazakaYashi typescript-web-template is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

package-lock.json

Lines changed: 51 additions & 48 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)