LOGO OA教程 ERP教程 模切知识交流 PMS教程 CRM教程 开发文档 其他文档  
 
网站管理员

内容创作工具Markdown编辑器的基本使用

admin
2024年12月31日 7:49 本文热度 256

一、入门基础


  1. Markdown 是什么?

Markdown 是一种轻量级标记语言,它通过简洁的符号和语法来对文本进行格式排版,让你能专注于内容创作,而无需花费大量精力在复杂的排版操作上。生成的文档可以轻松转换为 HTML、PDF 等格式,广泛应用于写作、文档编辑、博客撰写、代码注释等诸多领域。

  1. 编辑器选择


有许多支持 Markdown 的编辑器可供选择,例如:

    • Typora

      :界面简洁美观,实时预览功能强大,你输入 Markdown 语法的同时,就能看到排版后的效果,操作流畅,对新手友好。
    • VS Code

      :作为一款功能强大的代码编辑器,通过安装 Markdown 相关插件(如 Markdown All in One、Markdown Preview Enhanced 等),可以将其打造成专业的 Markdown 编辑器,还能结合代码编辑功能,方便编写技术文档。
    • 有道云笔记

      :不仅支持基本的 Markdown 语法,还依托云存储,方便随时随地记录和编辑文档,适合日常笔记记录与分享。


二、基本语法详解


  1. 标题


标题是文档结构的重要标识,使用 # 符号来表示。一个 # 对应一级标题,是文档的最高层级,字体最大且通常用于文章主标题,如 # 我的精彩游记;两个 # 即 ## 为二级标题,适用于章节标题,字体稍小,像 ## 旅途中的美食探索;以此类推,### 三级标题用于细分章节,层级越低字体越小,帮助构建清晰的文档层次。

  1. 段落


段落是构成文档的基本单元。在 Markdown 中,段落之间只需空一行即可自然分隔开,无需额外的标点或符号。当你在一行内输入文本,按下回车键换行后,如果没有空行,Markdown 会默认是同一段落,文字会自动连接,保持文本的连贯性。

  1. 加粗与倾斜

    • 加粗

      :若要突出显示某些重要文字,使其加粗显示,可使用 ** 或 __ 包裹需要加粗的文本。比如,你想强调某个关键词,写为 **关键要点** 或 __关键要点__,在渲染后就会显示为 关键要点,增强文字的视觉冲击力。
    • 倾斜

      :用 * 或 _ 包围要倾斜的文本,便能让文字呈现倾斜效果。例如 *这是一句富有诗意的话* 或 _这是一句富有诗意的话_,最终显示为 这是一句富有诗意的话,可用于增添文字的文艺氛围或表示引用等。


2.列表

一、无序列表


  1. 基本语法

    :使用 -、+ 或 * 作为列表项标记,后面紧跟一个空格,再输入列表内容。这三种标记符号效果相同,你可以根据个人喜好选择使用。例如:

- 红色的苹果

- 黄色的香蕉

- 橙色的橙子

将会显示为:

红色的苹果
黄色的香蕉
橙色的橙子
它适用于列举一些无序的项目,比如购物清单、待办事项中的任务分类等,能让内容的呈现更加清晰直观。

  1. 嵌套列表

    :无序列表还可以进行嵌套,以展示更复杂的层级关系。在子列表项前多添加几个空格或一个制表符(Tab)来表示层级缩进。例如:

- 水果

 - 苹果

  - 红富士

  - 国光

 - 香蕉

  - 海南香蕉

  - 菲律宾香蕉

- 蔬菜

 - 白菜

 - 萝卜

会呈现为:

    • 水果
    • 苹果
    • 红富士
    • 国光
    • 香蕉
    • 海南香蕉
    • 菲律宾香蕉
    • 蔬菜
    • 白菜
    • 萝卜
    • 这样的嵌套列表可以用于分类详细的信息,像目录结构、知识体系的细分等场景,帮助读者快速理解各项内容之间的从属关系。

二、有序列表


  1. 基本语法

    :以数字加 . 开头,后面跟一个空格和列表内容,常用于表示有先后顺序的步骤或事项。如:

1. 起床洗漱

2. 吃早餐

3. 出门上班

会呈现为:

    1. 起床洗漱
    1. 吃早餐
    1. 出门上班
    • 当你在有序列表中间插入或删除项时,大多数编辑器通常会自动调整序号,无需手动更改,省心省力。这使得有序列表在记录流程、步骤,如烹饪步骤、安装指南等方面表现出色。

  1. 结合无序列表使用

    :有序列表和无序列表可以结合使用,进一步丰富文档结构。例如在一个项目计划文档中:

1. 项目筹备阶段

    - 确定项目目标

    - 组建项目团队

2. 项目执行阶段

    - 任务分配

        - 开发任务

        - 测试任务

    - 进度跟踪

3. 项目收尾阶段

    - 成果验收

    - 项目总结

呈现出来后,既能体现项目的整体流程顺序,又能对每个阶段的具体事项进行分类罗列,让文档逻辑严谨、条理分明,便于团队成员理解和执行项目计划。


  1. 链接

    • 链接是让文档内容丰富多元的关键要素,有两种常见格式:
    • 行内式

      :最为直接,格式为 [链接文字](链接地址)。比如,你想分享一个学习网站,可写为 [慕课网](https://www.imooc.com),在阅读文档时,点击 “慕课网” 这一链接文字,就会跳转到对应的网址,方便读者获取更多信息。
    • 参考式

      :先在文档中某个位置定义链接,如 [慕课网]: https://www.imooc.com,然后在需要使用的地方写 [慕课网] 即可。这种方式特别适用于文档中多次引用同一链接的情况,便于统一管理链接地址,当链接需要修改时,只需更改一处定义,避免了多处修改的繁琐,维护起来更加便捷。
  1. 图片

    • 与链接类似,图片的 Markdown 格式为 ![图片描述](图片路径)。例如 ![美丽的夕阳](sunset.jpg),若图片路径正确,就会显示对应的图片,图片描述用于在图片无法加载时给用户提示信息,让读者大致了解图片内容,同时也有助于搜索引擎优化(SEO),提升文档的可读性和可用性。

  1. 引用

> 书籍是人类进步的阶梯。——高尔基

显示效果为:

书籍是人类进步的阶梯。—— 高尔基

> 有人说:

> > 生活不止眼前的苟且,还有诗和远方。

呈现为:

有人说:

生活不止眼前的苟且,还有诗和远方。

    • 使用 > 符号来表示引用,可用于突出显示名人名言、书籍摘录、他人观点等内容,让文档更具权威性和可读性。如:
    • 你还可以多层嵌套引用,通过多个 > 符号来实现,如:
  1. 代码块

def add(a, b):

return a + b

result = add(1, 2)

print(result)

这里指定了 python 语言,代码块中的函数定义、调用和输出语句会按照 Python 的语法高亮规则显示,一目了然。

    • 对于程序员或技术文档撰写者来说,代码块是 Markdown 的重要功能之一。
    • 对于少量代码,可以用反引号 ` 包裹,如 print('Hello World'),代码会以特定样式显示,与普通文本区分开,清晰地展示代码片段。
    • 若要显示多行代码,则使用三个反引号 ```,并可在后面指定代码语言,以获得语法高亮效果,帮助读者更清晰地理解代码逻辑。例如:
  1. 分隔线

    • 使用三个及以上的 - 或 * 来创建分隔线,例如 --- 或 ***,用于分隔文档的不同部分,使结构更清晰。比如在文章的章节转换、开头结尾处使用分隔线,能让文档层次分明,给读者视觉上的提示,便于阅读和理解。


阅读原文:原文链接


该文章在 2024/12/31 11:42:55 编辑过
关键字查询
相关文章
正在查询...
点晴ERP是一款针对中小制造业的专业生产管理软件系统,系统成熟度和易用性得到了国内大量中小企业的青睐。
点晴PMS码头管理系统主要针对港口码头集装箱与散货日常运作、调度、堆场、车队、财务费用、相关报表等业务管理,结合码头的业务特点,围绕调度、堆场作业而开发的。集技术的先进性、管理的有效性于一体,是物流码头及其他港口类企业的高效ERP管理信息系统。
点晴WMS仓储管理系统提供了货物产品管理,销售管理,采购管理,仓储管理,仓库管理,保质期管理,货位管理,库位管理,生产管理,WMS管理系统,标签打印,条形码,二维码管理,批号管理软件。
点晴免费OA是一款软件和通用服务都免费,不限功能、不限时间、不限用户的免费OA协同办公管理系统。
Copyright 2010-2025 ClickSun All Rights Reserved