Skip to content

Commit 69d3480

Browse files
committed
feat: 将模板引擎修改为mkdocs
1 parent 64640ad commit 69d3480

27 files changed

Lines changed: 846 additions & 806 deletions

.github/workflows/deploy.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Deploy MkDocs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [ main, master ]
6+
7+
permissions:
8+
contents: write
9+
10+
jobs:
11+
deploy:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout
15+
uses: actions/checkout@v4
16+
with:
17+
fetch-depth: 0
18+
19+
- name: Setup Python
20+
uses: actions/setup-python@v4
21+
with:
22+
python-version: '3.x'
23+
24+
- name: Install dependencies
25+
run: |
26+
pip install -r requirements.txt
27+
28+
- name: Deploy to gh-pages
29+
run: |
30+
git config --global user.name 'github-actions[bot]'
31+
git config --global user.email 'github-actions[bot]@users.noreply.github.com'
32+
mkdocs gh-deploy --force

.github/workflows/static.yml

Lines changed: 0 additions & 43 deletions
This file was deleted.

README.md

Lines changed: 46 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,64 @@
1-
# 前端工程化解决方案 -- Webpack
1+
# Webpack 实战教程 - 前端工程化解决方案
22

3-
```
4-
├─docs 文文档目录
5-
├─src 示例代码
6-
├─package.json npm项目依赖管理配置文件
7-
└─webpack.config.php webpack配置文件
8-
```
3+
[![Deploy MkDocs to GitHub Pages](https://github.com/webtechwiki/studywebpack/actions/workflows/deploy.yml/badge.svg)](https://github.com/webtechwiki/studywebpack/actions/workflows/deploy.yml)
94

10-
## 一、前端工程化
5+
这是一个使用 MkDocs 构建的 webpack 实战教程,采用 Material for MkDocs 主题,提供了现代化的文档阅读体验。
116

12-
### 1. 小白眼中的前端开发
7+
## 📖 在线阅读
138

14-
- 会写 HTML + CSS + JavaScript 就会前端开发
15-
- 需要美化界面样式,就拽一个 bootstrap 组件过来
16-
- 需要操作 DOM 或者发起 Ajax 请求,就拽 jQuery 过来
17-
- 需要快速实现界面布局,就拽 layUI 过来
9+
访问 [https://webtechwiki.github.io/studywebpack/](https://webtechwiki.github.io/studywebpack/) 在线阅读文档。
1810

19-
### 2. 实际的前端开发
11+
## 🚀 本地开发
2012

21-
- 模块化(js 模块化、css 模块化、资源模块化)
22-
- 组件化(复用现有的 UI 结构、样式、行为)
23-
- 规范化(目录结构的划分、编码规范化、接口规范化、文档规范化、Git 分支管理)
24-
- 自动化(自动化构建、自动部署、自动化测试)
13+
### 安装依赖
2514

26-
### 3.什么是前端工程化
15+
```bash
16+
pip install -r requirements.txt
17+
```
2718

28-
前端工程化是指:在企业级的前端项目开发中,把前端开发所需的工具、技术、流程、经验等进行规范化、标准化。
19+
### 本地预览
20+
21+
```bash
22+
mkdocs serve
23+
```
24+
25+
然后在浏览器中访问 `http://127.0.0.1:8000`
26+
27+
### 构建静态文件
28+
29+
```bash
30+
mkdocs build
31+
```
2932

30-
企业开发中的 Vue 和 React 项目,都是基于工程化的方式进行开发的。
33+
## 📚 内容目录
3134

32-
好处:前端开发自成体系,有一套标准开发方案和流程。
35+
1. [webpack基础使用](docs/webpack-basic.md) - 了解webpack的基本概念和使用方法
36+
2. [webpack插件](docs/webpack-plugin.md) - 学习如何使用和配置webpack插件
37+
3. [webpack加载器](docs/webpack-loader.md) - 掌握各种loader的使用技巧
38+
4. [打包构建](docs/build.md) - 学习项目的打包和构建流程
39+
5. [SourceMap](docs/sourcemap.md) - 了解源码映射的配置和使用
40+
6. [总结](docs/summary.md) - 回顾和总结webpack的核心知识点
3341

34-
### 4. 前端工程化解决方案
42+
## 🎨 特性
3543

36-
早期的前端工程化解决方案
44+
- 📱 响应式设计,支持移动端阅读
45+
- 🌙 支持暗色/亮色主题切换
46+
- 🔍 全文搜索功能
47+
- 📝 代码高亮和复制功能
48+
- 🔗 自动生成导航和目录
49+
- ⚡ 快速加载和流畅体验
3750

38-
- [grunt](https://www.gruntjs.net)
39-
- [gulp](https://www.gulpjs.com.cn)
51+
## 🛠 技术栈
4052

41-
目前流行的前端工程化解决方案
53+
- [MkDocs](https://www.mkdocs.org/) - 静态站点生成器
54+
- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) - 现代化主题
55+
- [GitHub Actions](https://github.com/features/actions) - 自动化部署
56+
- [GitHub Pages](https://pages.github.com/) - 静态网站托管
4257

43-
- [webpack](https://www.webpackjs.com)
44-
- [parcel](https://zh.parceljs.org)
58+
## 📄 许可证
4559

46-
> 在本系列文档中,我们将一起来熟悉与使用 Webpack
60+
本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
4761

48-
## 二、文档列表
62+
## 🤝 贡献
4963

50-
- [01-webpack的基本使用](./docs/01-webpack-basic.md)
51-
- [02-webpack中的插件](./docs/02-webpack-plugin.md)
52-
- [03-webpack中的加载器](./docs/03-webpack-loader.md)
53-
- [04-打包构建](./docs/04-build.md)
54-
- [05-SourceMap](./docs/05-sourcemap.md)
55-
- [06-总结](./docs/06-summary.md)
64+
欢迎提交 Issue 和 Pull Request 来改进这个项目!

_sidebar.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

babel.config.js

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/02-webpack-plugin.md

Lines changed: 0 additions & 99 deletions
This file was deleted.

0 commit comments

Comments
 (0)