Skip to content

Commit d50287e

Browse files
committed
add README.md
1 parent d7d210e commit d50287e

1 file changed

Lines changed: 44 additions & 1 deletion

File tree

README.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,44 @@
1-
# Tony's blog
1+
# Tony's Blog
2+
3+
## 项目简介
4+
这是 Tony 的个人技术博客,基于 GitHub Pages + Jekyll 搭建,记录在 macOS 开发环境、视频编码处理、iOS 工程实践、算法题解等领域的探索与经验。仓库中的 Markdown 文件位于 `_posts/` 目录,遵循 Jekyll 的命名规范(`YYYY-MM-DD-title.md`),构建后会自动发布到公开站点。
5+
6+
## 目录结构
7+
- `_posts/`:博客正文,按日期命名;
8+
- `_drafts/`:草稿(可选目录,如需在本地撰写未发布文章);
9+
- `assets/`:静态资源,包括图片、示例代码附件等;
10+
- `_config.yml`:站点与主题配置;
11+
- `Gemfile`:Jekyll 运行所需依赖;
12+
- `README.md`:当前说明文档。
13+
14+
## 本地预览
15+
1. 安装依赖:
16+
```bash
17+
bundle install
18+
```
19+
2. 启动预览服务:
20+
```bash
21+
bundle exec jekyll serve
22+
```
23+
3. 在浏览器访问 `http://127.0.0.1:4000` 查看实时效果。
24+
25+
如需自定义构建参数,可通过 `bundle exec jekyll serve --livereload --drafts` 预览草稿与增量更新。
26+
27+
## 写作规范
28+
- 文件名使用英文小写与连字符,前缀日期与文章发布日期保持一致;
29+
- Front Matter 至少包含 `layout: post``title``date``categories``tags`
30+
- 正文默认使用简体中文,必要时提供英文术语;
31+
- 代码块使用三反引号并指定语言标识,便于语法高亮;
32+
- 图片统一放在 `assets/img/post/<文章名>/` 目录,并在 Markdown 中引用绝对路径;
33+
- 文章结尾建议附上总结或后续阅读链接,保持结构一致性。
34+
35+
## 发布流程
36+
1. 本地完成撰写与校稿;
37+
2. 运行 `bundle exec jekyll build` 确认无错误;
38+
3. 提交代码并推送至 `main` 分支;
39+
4. GitHub Actions / Pages 将自动构建并发布最新内容。
40+
41+
如需回滚或重新发布,可通过 Git 标签管理历史版本。
42+
43+
## License
44+
除非正文另有说明,本仓库内容按 CC BY-NC-SA 4.0 协议共享,代码示例可在合理引用范围内自由使用。欢迎引用或转载,请保留出处链接。*** End Patch

0 commit comments

Comments
 (0)