SPT术语库

Markdown

写几行简单标记,就想让 README 自动变成有标题和目录的文档。

前端与交互约 10 分钟 · 从真实需求理解

1几行符号怎样变成一页可读文档?

SOURCE · README.md# 周末计划- 带水杯- 准备水果**别忘了湿巾**[查看路线](#route)
RENDERED · 页面预览

周末计划

  • 带水杯
  • 准备水果
别忘了湿巾查看路线

先看原始标记表达了什么。

项目 README 的文档预览里,Markdown 负责表达内容结构,渲染结果仍然要保持标题、列表和链接的含义。

  • 开始时:# 标题 · - 列表 · [链接]。
  • 完成后:README 预览已生成,结果留在当前场景。

2Markdown和HTML,什么时候不能互换?

Markdown Markdown网页结构 HTML:文档标题、列表、强调或链接的源文本用 Markdown 表达;HTML负责页面结构,Textarea负责让用户填写内容。

  • 要改变页面结构和语义标签,改 HTML,不要在 Markdown 里堆没有文档意义的标签。
  • 要让用户填写或修改内容,使用 Textarea;Markdown 本身只描述文档,不是输入控件。

3Markdown由哪些真实部分组成?

SOURCE · README.md# 周末计划- 带水杯- 准备水果**别忘了湿巾**[查看路线](#route)
RENDERED · 页面预览

周末计划

  • 带水杯
  • 准备水果
别忘了湿巾查看路线

页面预览和文档结构保持对应。

看项目 README 的文档预览里的真实界面:每个标注都对应一个页面部件,不用图片坐标猜位置。

  • 结构预览保持只读;这里重点看Markdown的原始标记和其他部件如何组成当前界面。
  • 点击编号或说明行可以定位对应部件;文档结构预览本身保持静态。

4Markdown什么时候用、什么时候不用?

写项目说明或教程
# 课程安排- 今日任务**交付时间**[文档入口](#docs)
不建议这样用复杂交互改用真实组件
- 联系方式- 预约日期- 提交后显示错误

Markdown什么时候用、什么时候不用?先看任务边界,再看组件外观。

  • 什么时候用:用标题、列表、强调和链接表达内容,渲染器再把它变成可读页面。
  • 什么时候不用:日期选择、校验和实时结果需要输入控件与状态,不要只在 Markdown 里写一段假表单。

怎么判断:先看用户要完成的任务和内容关系,再选择职责准确的组件。

5怎样把Markdown需求交给 Agent?

请使用 Markdown 源文本实现项目 README 的文档预览:用 # 表达标题,用 - 表达列表,用 ** 表达强调,用 [文字](地址) 提供链接。保留源文本和渲染结果的对应关系;不要把 Markdown 当成 HTML 结构或输入控件,也不要用 iframe、手写颜色或 CSS 去替代文档语义。

6不用背,看看你能不能判断

1 / 3

Markdown最主要解决什么问题?

请选择一个最符合题意的答案

选择答案后自动进入下一题

社区延伸

看别人真实遇到过什么

社区帖子还没有关联到这个词条。