一份程序员必备的Markdown备忘单!

轻瑶大大_3089

轻瑶大大_3089

2023-02-16

1242人浏览

转载

本篇文章给大家带来了关于Markdown的相关知识,其中主要内容就是总结分享大家一份Markdown备忘单,感兴趣的朋友下面一起来看一下吧,希望对大家有帮助。

markdown 是一种轻量级的标记语言,我们可以用它来格式化纯文本文档。

GitHub上的每个仓库都有自己的README文件,解释了该仓库的目的。每个项目都需要好的文档。GitHub 的文档是用 Markdown 编写的。这也正是为什么需要很好地处理一些基础知识。有很多元素你可以用Markdown来写,所以我们来深入了解一下。

段落

通过写常规文本,基本上是在写一个段落。

image.png

标题

有6种标题变体。符号 "#" 的数量,以及后面的文字,表明标题的重要性。

image.png

强调

修改文本是如此整洁和容易。你可以让你的文字变成粗体、斜体、删除线、高亮、下标或上标。

image.png

引用

image.png

图片

如果你使用的是GitHub,最好的方法是直接从电脑上拖放图片到README文件。你也可以为图片创建一个引用,并通过这种方式来分配它。以下是语法。

image.png

链接

与图片类似,链接也可以直接插入或通过创建一个参考。可以创建内联和块状链接。

image.png

代码

你可以创建内联式和全块式的代码片断。还可以定义在代码片段中使用的编程语言。所有这些都是通过使用反斜线。

image.png

列表

正如你在HTML中可以做的那样,Markdown允许创建有序和无序的列表。

image.png

也可以混合这两个列表并创建子列表。

image.png

还可以创建定义列表(术语-定义):

Markdown Docs Full-Text Search
Markdown Docs Full-Text Search

使用 SQLite FTS5 对结构化 Markdown 文档库进行全文搜索,适用于需要快速、高效搜索大量 Markdown 文章的场景。

下载

image.png

表格

显示排列整齐的数据的好方法。使用**"|"** 符号来分隔列,使用 ":" 符号来对齐行内容。

image.png

也可以通过排除外部的 "|" 符号和不使你的代码有良好的结构来创建一个 "混乱的"表格。

image.png

列表

追踪已经完成的任务和需要完成的任务。

image.png

脚注

想在文件的末尾描述一些东西?用脚注吧!

image.png

标题标识

你可以给一个标题赋予ID,以便从你所在的地方直接跳到文件的那个部分。

image.png

你可以使用星号、连字符或下划线(*、-、_)来创建一个横线。唯一的规则是,你必须包括至少三个字符的符号。

image.png

这里,我创建了一个GitHub repo,大家可以用这个地址来练习:

github.com/im-luka/mar…

原文:dev.to/imluka/the-…

代码部署后可能存在的BUG没法实时知道,事后为了解决这些BUG,花了大量的时间进行log 调试,这边顺便给大家推荐一个好用的BUG监控工具 Fundebug。

相关专题

更多
Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

2026.11.12

120

15

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.12

100

15

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

2026.11.12

60

15

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

160

12

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

2026.11.06

140

13

Postman接口请求发送教程
Postman接口请求发送教程

详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。

2026.11.06

120

10

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

2026.11.05

100

12

DBeaver安全防护教程大全
DBeaver安全防护教程大全

DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。

2026.11.05

100

12

DBeaver连接创建与配置教程
DBeaver连接创建与配置教程

本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。

2026.11.04

100

16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Markdown标记语言快速入门
Markdown标记语言快速入门

共30课时 | 4.5万人学习

vscode常用插件与markdown语法介绍
vscode常用插件与markdown语法介绍

共10课时 | 1.5万人学习