Markdown,一个属于程序员的文档记录方式

一、什么是markdown

    markdown 是一种轻量级的标记语言,其用纯文本编写文档(易读、易写、易更改),因此可以用常见的文本编辑器打开并编辑,然后经过markdown编译器编译为带格式的文本。
  markdown的目标是实现“易读易写”,即通过简单的标记便可以实现带有格式的文本的编写。与word所见即所得不同的是,markdown让作者更专注于内容,格式交给相应的标签。markdown因其便捷性(可用任何软件打开编辑,不像word局限于一种特定的格式)和平台独立性,广泛应用于网站开发、技术文档的书写、电子邮件和便笺等领域。

二、编辑器

  markdown是用纯文本编写文档的,因此最基础的编辑器有记事本,只需将编写后的.txt后缀改为.md即可,但记事本的编写效率低下,且无法实时预览。
  一些常用的 markdown 编辑器有Markdown MonsterMouMarkdownPadTyporaAtom等,在线编辑器 Dillinger,不同编辑器的显示样式可能略有不同,但大同小异。若无说明本文的效果均为在Visual Studio Code 上的实现效果。

三、标题

  标题是用标记 # ,井号的个数表示标题的级别,个数越多级别越低,共有六个级别。
  标记
  样式
  可以看到,在Visual Studio中,一级标题下面会出现一条横线,但是在Github中一级标题和二级标题下面都会出现横线,但是在某些软件中所有标题下面都不会出现横线,比如markdown的网页版处理程序 Dillinger

四、超链接和图片

  超链接的格式为 [锚](链接的地址),图片的格式为 ![图片无法正常加载时的显示文字](图片地址 鼠标移动到图片上的显示文字)

  标记
  样式
  可惜的是目前 markdown 中插入的图片还不支持调整图片的大小,但是相信不久这一功能会实现的。

五、表格

   markdown 可以实现表格效果,还可以对表格的内容对齐方式进行设置。

  标记
  样式
  可以看到表格的实现主要有三个部分:

  • 表头:用 | 将单元格内容包住;
  • 表头和主体分隔符:用 | 将中划线 - 包住,中划线 - 的个数不限(最少一个);
  • 主体:和表头一样,用 | 将单元格内容包住。
      可以在中划线的左右添加冒号 : 来进行单元格内容的对齐方式,在 - 的左边添加 : ,则该列的单元格左对齐;在 - 的右边添加 : ,则该列的单元格右对齐,在 - 的左边和右边同时添加 : ,则该列的单元格居中对齐。表格的单元格默认对齐方式是左对齐。

六、列表

  话不多说,先看效果。

  标记
  样式
  列表分为有序列表和无序列表两种:

  • 有序列表:1. 用阿拉伯数字和 . 作为前缀,但要切记前缀和内容之间需要一个空格分隔;2. 有序列表会以第一项的前缀阿拉伯数字作为基础,之后的每一项前缀阿拉伯数字都是在前一项的基础上加1。
  • 无序列表:无序列表的前缀有三个符号可用,分别是加号 + ,减号 - 和星号 * ,需要注意的是前缀和内容之间需要一个空格分隔。

七、代码

  为了能让代码在文件中高亮显示,markdown 提供了代码的标记方式,包括行内代码和代码块。
  标记
  样式
  行内代码用一对反引号 `` 将代码内容包起来即可;对于代码块,有两种方式,第一种是用一对``````符号将代码块包住即可,另一种方式是代码块的每一行缩进4个空格或一个制表符,但这时需要注意代码块需要与前面的内容隔一行。

八、引用

  引用用符号 > 标记。
  标记
  样式
  可以看出 > 的个数决定了引用的级别。

九、其他

1. 换行

  markdown 中换行非常简单,只需要在换行处加上 两个空格 即可。

2. 空行

  文本中时常需要一个空行,以表示一个段落的开始,markdown 中空行非常简单,只需 空出一行 即可。

3. 缩进

  可以通过添加空格来实现缩进。

 :空出一个汉字字符的距离;

 :空出半个汉字字符的距离;

 :空出1/4个汉字字符的距离;

一个空格:空出1/4个汉字字符的距离。

4. 加粗和斜体

  用星号 * 和下划线 _ 作为标记,一个标记写斜体,两个标记加粗。

  标记
  样式

5. 分割线

  分割线用星号 * 和中划线 -以及下划线 _ 标记,但至少要有三个。

  标记
  样式

6. 符号转义

  因为 markdown 中用了许多符号,例如星号 * 、反引号`等,所以如果要在文本中使用这些特殊符号,就需要进行转义,也非常简单,用反斜 \ 加上这些符号就OK了。

7. 删除线

  用一对波浪线~~将需要添加删除线的文字扩住就可。

在这里插入图片描述

在这里插入图片描述


十、扩展语法

  上面介绍的是markdown的基本语法,但是这些功能可能并不能满足某些人的更高的需求,基于对基本语法进行扩展。一些应用程序可能不支持扩展语法,需要自己添加扩展。

1.语法高亮

  对于程序开发者来说,说明文档中常常会添有大量的代码,让这些代码依据不同的编程语法高亮显示将极大地提高读者的阅读体验。实现语法高亮显示只需在``````符号对的第一部分后面加上对应的编程语言即可。下面的效果是在Dillinger实现的。
语法高亮
在这里插入图片描述


参考文章

W3Cschool中Markdown介绍
Markdown中文官网

  • 4
    点赞
  • 14
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
### 回答1: 我可以给你一些代码,可以让你使用Markdown语言记录你的刷题记录:``` # 刷题记录## 今日刷题- 题目 1: - 解答:- 题目 2: - 解答:## 昨日刷题- 题目 1: - 解答:- 题目 2: - 解答: ``` ### 回答2: 生成一个markdown语言的代码刷题记录可以通过以下步骤完成: 1. 创建一个markdown文件,命名为"刷题记录.md",并打开编辑器。 2. 在文件中添加一个标题,例如"刷题记录"。 3. 在下方添加一个表格,表格包含以下列:日期、题目名称、题目难度、代码链接、思路。 4. 为每一道题目添加一行记录,按照日期倒序排列。每行填写相应的信息,包括日期、题目名称、题目难度、代码链接和思路。 示例: | 日期 | 题目名称 | 题目难度 | 代码链接 | 思路 | | -------- | ------------ | ---------- | ----------- | -------- | | 2021/1/1 | 两数之和 | 简单 | [代码链接]() | 思路描述 | | 2021/1/2 | 反转链表 | 中等 | [代码链接]() | 思路描述 | | 2021/1/3 | 接雨水 | 困难 | [代码链接]() | 思路描述 | | ... | ... | ... | ... | ... | 5. 在代码链接处添加相应题目的代码链接,可以使用GitHub或Gist等代码托管平台。 6. 在思路处添加题目解法的思路描述,可以简要概括解法的关键步骤或思想。 完成以上步骤后,保存并关闭markdown文件。这样就生成了一个简单的代码刷题记录,方便查看和整理自己的刷题历程,以及回顾解题思路。 ### 回答3: 生成一个markdown语言的代码刷题记录可以按照以下步骤进行: 1. 首先创建一个markdown文件,可以以`.md`为扩展名,比如`leetcode.md`。 2. 在markdown文件中使用标题,表示题目的名称和难度。比如: ``` # [题目名称](题目链接) - 难度 ``` 3. 接下来,按照以下格式记录每道题目的代码和解题思路: ``` ## 题目描述 题目的具体描述和要求。 ## 解题思路 解题的思路和步骤。 ## 代码实现 使用适当的代码块标记,插入代码。 ```python # Python代码示例 解法代码 ``` ```cpp // C++代码示例 解法代码 ``` ## 复杂度分析 对解法进行时间复杂度和空间复杂度的分析。 ## 总结 对题目和解法进行总结。 ``` 4. 按照上述格式记录完每道题目的代码和解题思路后,保存markdown文件。 5. 在记录新的刷题内容时,可以按照上述格式在文件后面追加新的题目记录。 总结起来,生成一个markdown语言的代码刷题记录,需要创建一个markdown文件,并按照一定的格式记录每道题目的代码和解题思路。这样可以方便地查看每道题目的代码和解法,并进行总结和复习。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值