判断标准:一份 Markdown 是否可维护,取决于是否区分 CommonMark 基础语法与 GFM 扩展语法。日常写作建议以 CommonMark 为底线,只有在 GitHub、GitLab、Notion 等明确支持 GFM 的环境,才使用表格、任务列表、删除线等扩展。 一、标题与段落 标题用 `#` 到 `######`。一篇文档通常只保留一个一级标题,正文内从二级标题开始,不要跳级。段落间
判断一份 Markdown 文档是否合格,可以看两条:在纯文本状态下是否易读;渲染后是否层次清楚、不产生歧义。日常写作优先使用 CommonMark 核心语法;需要表格、任务列表、删除线时,再使用 GitHub Flavored Markdown(GFM)扩展。以下按使用频率组织。 标题与段落 标题用 `#` 至 `######`,一级标题通常一个文档只出现一次。不要跳级:如果上一级是 `##`,
判断一份 Markdown 文档排版是否合格,通常看三个条件:渲染后目录层级连续、列表与代码块缩进一致、平台特有语法不干扰阅读。排版的目标不是装饰,而是让读者能快速扫读,让渲染器稳定输出。 ## 标题与段落 标题用于划分文档骨架,不用于放大字号。二级标题是主要分节,三级及以下逐级展开;不要从二级直接跳到四级。先列二级标题形成大纲,再在每节内填段落。普通段落之间空一行,不要用连续空格或 Tab 模拟
要判断一份 Markdown 文档是否合格,核心标准是:结构可扫读、语法可渲染、维护成本低。满足这三条,通常就能作为可靠的技术文档、项目说明或知识库内容长期使用。 适用场景与边界 Markdown 最适合以标题、列表、代码块、表格和链接为主的文本内容,例如 README、接口说明、操作手册、个人笔记和静态站点源文件。判断标准:如果内容主要靠文字结构和少量标记表达,选择 Markdown 成本最低;
Markdown 的核心价值在于:同一份源文件既能直接阅读,也能渲染为结构化文档。日常写作只需掌握标题、段落、强调、列表、引用、链接、代码和表格八类语法即可覆盖多数场景。复杂排版应优先确认目标平台是否支持,不要用 Markdown 模拟视觉排版。 标题与段落 适用场景:任何需要分节的文档,如 README、笔记、技术方案、接口说明。 判断标准:一级标题通常对应文档标题,正文主要分节从二级标题开始;
Markdown 的价值在于把“内容结构”写成纯文本,同时能被稳定渲染。判断一份 Markdown 是否合格,看三点:源文件不渲染也能读;标题、列表、代码块层级清楚;在目标平台(GitHub、Typora、语雀、博客系统等)预览无错位。学习顺序建议先掌握 CommonMark 核心语法,再按平台补充表格、任务列表、脚注等扩展。 标题与段落:先建立结构 标题用 `#` 到 `######`,分别对应
标题里的“markerdown”通常按 Markdown 理解。判断一份 Markdown 文档是否合格,可以看三点:不渲染时源文本仍可读;渲染后标题、列表、代码层级清楚;复制到目标平台后不出现大面积破版。满足这三点,语法就用对了;只追求花哨扩展,往往会增加迁移成本。 ## 一、先确定语法边界:基础优先,扩展按平台启用 Markdown 分基础语法和扩展语法。基础语法包括标题、段落、粗体、斜体、列