开发者故事 #1 使用 Markdown 高效率编写文档

1,173 阅读5分钟

⭐️ 本文已收录到 AndroidFamily,技术和职场问题,请关注公众号 [彭旭锐] 和 [BaguTree Pro] 知识星球提问。

我越来越意识到,每个人都是独一无二的,每个人最大的原创就是自己!在这个专栏里,小彭将为你分享开发路上的点点滴滴,加入掘金社区,一起成长。

本文是开发者故事系列的第 1 篇文章,完整文章目录请移步到文章末尾~


前言

  • HTML(HyperText Markup Language)是重量级的标记语言,造就了主次分明、层次清晰的网页
  • Markdown是一种轻量级的标记语言(Lightweight Markup Language),满足了主要的文本格式标记的需求,操作性大大简化,易写易读

兼容性

市面上存在太多的Markdown编辑器,遵循以下经验有助于实现更好的兼容性:

  • 缩进

    应该使用显式的缩紧语法,而不应该使用Tab键

    不兼容用法:Tab段落
    正确用法:  段落

  • 完整而精简

    确保没有多用或者少用标记符号

    不兼容用法:-- 列表、```代码
    正确用法:- 列表、```代码```

  • 空格

    不应该忽略分割标记符与文本的空格

    不兼容用法:#一级标题
    正确用法:# 一级标题

  • 转义符

    确保所有需要转义的符号都带了转义符

  • 检查

    事实上,很难确保同一篇md文档在所有编辑器上保证一致的显示。在遵循以上经验的前提下,移植文档之后还需要认真检查


1、标题

  • 1.1、六级标题
    • 举例:
    # 一级标题
    ## 二级标题
    ### 三级标题
    #### 四级标题
    ##### 五级标题
    ###### 六级标题
    
    • 效果:

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题
  • 1.2、高级标题与次级标题
    • 举例:
    高级标题
    =
    次级标题
    -
    
    • 效果:

高级标题

次级标题(次级标题稍微小一些)


2、文本效果

  • 斜体

    • 举例:*斜体*、_斜体_
    • 效果:斜体斜体
  • 加粗

    • 举例:**加粗文字**、__加粗文字__
    • 效果:加粗文字加粗文字
  • 删除

    • 举例:~~删除内容~~
    • 效果:删除内容

3、引用

段落前添加一个**>来标记为引用,重复使用>>可以创建更多级别的引用,使用一个空行**来结束该级别。

  • 举例:
    >something
    >>something
    >something(X 降级需要先使用一个空行结束上一级的引用)
    
    something
    
  • 效果:

something

something something

something


4、分割线

使用三个或以上的***-** 或**_来来创建分割线,符号后不能接其他内容。(注意:使用__---__时,在之前空一行**,可以避免被当作标题标记)。

  • 举例:
***
---
___
  • 效果:




5、链接

  • 文内链接

    • 举例:
    something[链接说明](http://www.baidu.com "optional hint")something
    注意:网址和提示字符串之间需要空格
    
  • 引用链接 和文内链接类似,但是它把链接的内容放在其他位置,可以使可以被识别的任意位置。

    • 举例:
    This is [链接说明] [id] 
    [id]: http://www.baidu.com/ "Optional Title Here"
    注意:网址和提示字符串之间需要空格
    
    • 效果:
      This is [链接说明] id reference-style link
  • 超链接或邮箱
    • 举例:
    something<http:www.baidu.com>something
    something<809072649@qq.com>something
    

6、插入图片

插入图片和插入链接非常类似,只是在方括号前多一个**!**。

  • 举例:
    [图片上传失败...(image-8361f6-1564327831975)] 
    注意:路径和提示字符串之间需要空格
    
  • 效果:

图片说明


7、列表

  • 举例:

    |左对齐|中间对齐|右对齐|
    |:---|:---:|---:|
    |左1|中1|右1|
    |左2|中2|右3|
    
  • 效果:

    左对齐中间对齐右对齐
    左1中1右1
    左2中2右3

8、引用参考

参考内容会被放到文末,点击即可实现跳转(注意:^后的文本是任意的,会被解析成有序的数字,在参考内容后接空行来标记参考内容结束)。

  • 举例:
    使用 Markdown[^3]可以效率的书写文档, 直接转换成 HTML[^2], 你可以使用 Leanote[^Le] 编辑器进行书写。
    [^3]:Markdown是一种纯文本标记语言
    [^2]:HyperText Markup Language 超文本标记语言
    [^Le]:开源笔记平台,支持Markdown和笔记直接发为博文
    
  • 效果:
    使用 Markdown1可以效率的书写文档, 直接转换成 HTML2, 你可以使用 Leanote3 编辑器进行书写。

9、上下角标

  • 举例:
O<sup>2</sup>
O<sub>2</sub>
  • 效果:
    O2
    O2

10、换行

**<br>或者<br/>**用来标记换行


11、转义

使用**\**进行转义


12、代码

使用两个**```**将代码包围起来


13、命名描记(页内超链接)

跳转到的地方 点击跳转


14、缩进

空格半格一格
&nbsp;&ensp;&emsp;
  • 举例:
    文本&nbsp;文本&ensp;文本&emsp;文本
    
  • 效果: 文本 文本 文本 文本

推荐阅读

开发者故事完整目录如下(2023/07/11 更新):

⭐️ 永远相信美好的事情即将发生,欢迎加入小彭的 Android 交流社群~

Footnotes

  1. Markdown是一种纯文本标记语言

  2. HyperText Markup Language 超文本标记语言

  3. 开源笔记平台,支持Markdown和笔记直接发为博文