博客样式预览:从一篇笔记到一篇文章
一篇用于预览中文排版、分级目录、代码、表格和文章引用的测试文章。
这是一篇样式测试文章,用来看看博客实际读起来是什么样。这里的文字只用于展示排版,之后可以替换或移除。
为什么保留一个写作空间
日常笔记记录的是思考发生的过程:一个还没想清楚的问题、一条解决报错的命令,或是一段值得继续追问的想法。它们不需要在写下时就成为文章。
公开文章则多走一步:交代背景,把必要的上下文补齐,让第一次遇到这个问题的人也能读懂。
先把事情做明白,再把经历写清楚。
中文与英文
中文是原稿。英文版在中文内容整理后翻译,尽量保留原文的语气、判断和技术细节。同一篇文章的两个版本可以通过标题下方的语言链接切换。
文章之间的联系
有些内容值得独立成篇,然后在需要的地方互相引用。例如,这篇引用示例 展示了如何补充阅读路径。本文底部的“文章导航图”可以展开查看它们的关系。
把一次实践写清楚
从具体的问题开始
写清楚当时想解决什么、使用什么环境,以及怎样判断结果是否正确。读者需要知道一段操作适用于什么条件。
- 描述遇到的问题。
- 给出必要的操作与解释。
- 说明验证结果,以及仍然不确定的部分。
命令与代码
短命令可以直接写在句子里,例如 git status。稍长的操作适合放进代码块:
from pathlib import Path
notes = sorted(Path("notes").glob("*.md"))
for note in notes:
print(note.stem)
代码保持等宽字体,较长的行可以在代码块内部横向滚动。
用表格比较选择
| 内容 | 适合放在哪里 | 什么时候整理 |
|---|---|---|
| 临时想法与线索 | 私人笔记 | 开始持续使用时 |
| 可复用的方法 | 长期笔记 | 再次遇到同类问题时 |
| 经过梳理的经验 | 公开博客 | 背景、过程与结论完整时 |
给阅读留一点空间
一篇文章不一定很长。清楚的问题、可信的过程,以及恰当的结论,就足以让一次记录值得被阅读。
后续可以写什么
- 一次技术实践中的关键判断。
- 一篇论文引出的具体问题。
- 一套真正持续使用的工作流。
延伸阅读
继续阅读 文章之间如何相互引用,也可以切换到 English 对比英文排版。
文章导航图
箭头从引用文章指向被引用文章。点击节点可以跳转;中英文译文不重复显示。