我用 Markdown 写书和研究论文,专门在 GitHub 上发布,而 Markdown 中的 HTML 标题标签在 GitHub 上不起作用,所以我使用以下约定:
Document Title
==============
***This is a subtitle***
**Author:** *Me*
# Chapter One: Overview
Do you know the way?
---
# Chapter Two: Foo
Foo is the way...
---
最终看起来像:
文件名
这是字幕
作者: 我
第一章:概述
你知道路吗?
第二章 Foo
福是路...
我使用---
来分隔章节,因为它看起来不错并且有助于在文本中找到章节。但是,当 Markdown 文档变大时,这确实会出现问题,在这种情况下,Markdown 预览窗口会在您每次键入时开始冻结,因为它会刷新或 Grammarly 开始出错并需要很长时间。这是使用 H1 标题格式的理由,===
因为当文档变大时,您需要将其分解,在这种情况下,最好使用以下格式:
Document Title
==============
***This is a subtitle***
**Author:** *Me*
[<< Previous Chapter](URL) | [Content Table](URL) | [Next Chapter >>](URL)
---
# Chapter Two: Foo
Foo is the way...
---
[<< Previous Chapter](URL) | [Content Table](URL) | [Next Chapter >> ](URL)
然后看起来像:
文件名
这是字幕
作者: 我
<< 上一章| 目录| 下一章>>
第二章 Foo
福是路...
<< 上一章| 目录| 下一章>>
我也放弃了使用 Wiki 文件名作为标题,因为它不允许连字符,这会弄乱我的章节标题,所以我已经切换到所有以章节索引01_chapter_name.md
, 02_chapter_name-with-hyphens.md
, ...开头的小写文件名===
H1 标题格式并将我的 Markdown 书籍移动到主存储库,这样我就可以使用问题驱动开发和 GitHub 问题和项目,每章一个项目,这样我就可以记住所有要做的事情并完成积压工作。