美文网首页
MacDown,优雅的文档编写方式

MacDown,优雅的文档编写方式

作者: Jackie_123 | 来源:发表于2019-11-21 16:39 被阅读0次

  对于程序员来说,写文档也是在代码外的一项技能。能够用代码的方式进行文档的编写我觉得是相当不错的行为。相信我,当你熟悉使用Macdown之后你会喜欢上这种文档书写方式。
  下面我将说下我在使用MacDown当中用到的语法:

  1. 在中文书写时我们通常习惯段首缩进两个字,但是使用markdown编辑时我们手打空格缩进是不起效果的,因此我们需要通过使用HTML中的空格实体来帮助我们实现缩进效果。
    一个汉字占两个空格大小,所以使用四个空格就可以达到首行缩进两个汉字的效果。有如下几种方法:
  • 一个空格大小的表示:  ,此时只要在相应需要缩进的段落前加上 4个 如上的标记即可,注意要带上分号
  • 两个空格的大小表示:  ,同理,使用2个即可缩进2个汉字,推荐使用该方式
  1. 粗体与斜体
    用 ** 包裹的为粗体内容,用 * 包裹的为斜体内容。
    粗体文字 **粗体文字**
    斜体文字 *斜体文字*
    加粗斜体***加粗斜体***
    3.标题
    MacDown的标题分为一级到六级,其写法如下,建议 # 与 标题 之间加上空格,此为标准写法。

title

title

title

title

title
title
#title

##title

###title

####title

#####title

######title
  1. 列表
    列表分为无序列表和有序列表,无序列表在文字前加 * 或 - 即可,有序列表需要在文字前加上 1. 2. ... ,注意符号和内容之间的空格。

无序列表

  • 无序列表
    • 无序列表
  • 无序列表
  • 无序列表

有序列表

  1. 有序列表
    1.1 有序列表
  2. 有序列表
  3. 有序列表
###无序列表
* 无序列表
    * 无序列表
* 无序列表
* 无序列表

###有序列表
1. 有序列表
    1.1 有序列表
2. 有序列表
3. 有序列表
  1. 引用
    如果你需要引用格式的效果,只需在文字前面加上 > 符号。

这里是引用的内容
这里是引用的内容

>这里是引用的内容
>这里是引用的内容
  1. 图片与链接
    插入链接:[文字内容](链接地址)
    插入图片: [图片内容]()

  2. 表格

| 默认格式  | 左对齐 | 居中 | 右对齐 |
| --- | :--- | :---: | ---: |
| 默认格式表格内容  | 左对齐表格内容 | 居中表格内容 | 右对齐表格内容 |
| 默认格式表格内容  | 左对齐表格内容 | 居中表格内容 | 右对齐表格内容 |
默认格式 左对齐 居中 右对齐
默认格式表格内容 左对齐表格内容 居中表格内容 右对齐表格内容
默认格式表格内容 左对齐表格内容 居中表格内容 右对齐表格内容
  1. 代码块
    使用 ` 包裹代码,如需要插入代码块则需要 ``` 或 ~~~ 包裹代码块。
`这里是单句代码`

这里是单句代码

```这里是多行代码```(```请单独做为一行)
这里是多行代码
  1. 分割线
    使用 *** 或 --- 即可


参考链接:
MacDown 日常使用参考教程
markdown空格缩进以及HTML空格实体

相关文章

  • MacDown,优雅的文档编写方式

      对于程序员来说,写文档也是在代码外的一项技能。能够用代码的方式进行文档的编写我觉得是相当不错的行为。相信我,当...

  • 接口文档的编写

    参考资料 如何优雅的格式化接口 如何优雅的“编写”api接口文档 接口文档的编写

  • 更优雅的接口文档编写方式 — YApi

    背景 系统开发过程中,必然少不了文档,而在互联网应用系统开发中,API接口文档则更是必不可少。 YApi YApi...

  • Macdown简单使用笔记

    以前malgee也使用macdown编写文件,不过没怎么深入了解,由于最近要写个用户体验文档,格式比较多,就想起来...

  • 文档编写和日程备忘工具:Notebooks for Mac

    还不知道哪款Mac记事本工具好用,可以轻松编写文档和日程备忘录?macdown推荐这款Notebooks Mac版...

  • macdown 格式编写规范

    标题 一级标题 二级标题 三级标题 四级标题 五级标题 粗体 加粗字体 斜体 斜体字体 斜体与加粗 斜体加粗字体 ...

  • 如何优雅的“编写”api接口文档

    前言 今天我需要把之前写的接口整理成文档,老大给了意见用swagger搞,我像发现新大陆一样的兴奋,迫不及待得去“...

  • 在线生成接口文档

    接口文档是项目开发中必需的说明文档,接口文档编写有很多不同的方式,今天本文简单介绍一下常用的几种接口文档编写方法。...

  • 一键生成 API 文档的妙招

    一般接口文档编写完成后,就要开始编写调用接口的代码,很多开发团队都采用传统的通过接口文档的方式来编写接口。但在接口...

  • 如何优雅的“编写”api接口文档(续)

    接着上一篇如何优雅的“编写”api接口文档 这篇续篇主要说一下以下三点 文件上传参数配置 单独部署SwaggerU...

网友评论

      本文标题:MacDown,优雅的文档编写方式

      本文链接:https://www.haomeiwen.com/subject/twstwctx.html