markdown 让你快速无痛学会编写IT文档

掌握Markdown:使用Salmon编辑器简化文档编写 Markdown编辑器是文本编辑的一种新趋势,尤其受到IT从业者的青睐。它以其简洁、高效、易读的特点,使得文本编写和格式排版变得更加简单直观。Markdown编辑器通过简单的标记语言,为用户提供了一种无需切换到富文本编辑器即可编写格式化文本的能力。这些标记被转换为HTML或PDF,方便在网页和文档中分享。在这一章中,我们将探究Markdown编辑器的起源、它的工作原理以及它为何成为开发者和内容创作者的首选工具。此外,我们还将介绍一些流行的Markdown编辑器及其特色功能。 阅读详情

Markdown就是一种文档的格式,专业名称为轻量型标记语言,主要用于编写文档类的内容,特别适合IT类的文档编写。

目前绝大多数的IT技术论坛都是支持使用markdown编写博客与文章的,例如github,简书,csdn等,在IT行业有着不可替代的作用,以其快捷简单著称~!

markdown的编写并不复杂,下面就为大家讲解markdown的10大标准编写格式吧~

编辑器此处使用的VSCODE 原生支持markdown编写,后缀为.md,另外没有编辑器,可以使用在线的编辑器呀,这里给大家推荐一个https://tool.lu/markdown/

写在最前面:所有标记和内容在一行的,标记和内容中间必须至少有一个空格,否则会被当做内容处理!

1.标题的编写

标题主要分为两大类:主副标题和多级标题

主副标题:

主标题:内容的下一行使用连续三个===
副标题:内容的下一行使用连续三个—


南风老师为何光屁股直播?(主标题)
===

震惊,南风老师没裤衩换了!(副标题)
---


此处省略1W字,简单的说,南风老师的裤衩不是脏了没洗就是洗了没干~!

显示效果:
在这里插入图片描述

多级标题:相当于H1-H6标签

标题内容前面使用# ,几个#就是多少级标题,最多6个~

# 一级标题

## 二级标题

### 三级标题

#### 四级标题

##### 五级标题

###### 六级标题

显示效果为:
在这里插入图片描述
注意:使用多级标题,#后面必须有空格


2. 列表的编写

列表分为两大类:有序列表 和无序列表

有序列表

有序列表需要使用数字进行编号。

AMD6000系列显卡性能排行:

1. RX6900XT
2. RX6800XT
3. RX6800
4. RX6700XT
5. RX6600XT
6. RX6600
7. RX6500XT

显示效果为:
在这里插入图片描述

无序列表

无序列表使用的符号 - + * 任意一个都可以

AMD显卡厂商:

+ 华硕
+ 微星
+ 讯景
+ 瀚恺
+ 蓝宝石


AMD显卡厂商:(喜欢)

- 华硕
- 微星
- 讯景
- 瀚恺
- 蓝宝石


AMD显卡厂商:

* 华硕
* 微星
* 讯景
* 瀚恺
* 蓝宝石

显示效果为:
在这里插入图片描述

列表也可以嵌套使用

英伟达显卡厂商及产品分类

- 华硕
  1. 玩家国度
  2. 骑士系列
  3. Mini系列 
- 微星
  1. 闪电
  2. 超龙
  3. 魔龙
  4. 万图师 
- 七彩虹
  1. 九段
  2. 烈焰战神X-TOP
  3. 烈焰战神-U
  4. 冰封骑士

显示效果为:
在这里插入图片描述
注意:列表的嵌套使用无所谓有序与无序都可以互相嵌套


3. 表格

表格书写包含行列设计以及对齐方式。

表格格式

|姓名|性别|年龄|三维|
|---|:---|---:|:---:|
|南风|男|99|99,99,99|
|楚楚|女|18|6D,85,115|
|玉米|男|14|38D,120,110|

显示效果:
在这里插入图片描述
提示:在源代码中,|—|—|—|格式用于控制列数,|—:|中的冒号用于控制内容的对其方式,

|:---| 表示该列内容靠左对齐,
|---:| 表示该列内容靠右对齐
|:---:| 表示该列内容剧中对齐
注意:,第一行内容为表格的表头设置,必须填写,且表头默认居中对齐不受对齐方式的影响,另外内容两侧可以随意添加空格和缩进,没有影响,不过没有必要,源代码不需要上线对齐。


4.分割线

分割线就一种样式 但是有6种格式:
都是在新的一行开头连书!!

分割线1 -> ***

***

分割线2 -> * * *

* * * 

分割线3 -> ---

---

分割线4 -> - - -

- - - 

分割线5 -> ___

___

分割线6 -> _ _ _ 

_ _ _ 

显示效果为:
在这里插入图片描述
注意:分割线的符号需要与内容隔开一行,否则部分编辑器解析有问题,分割线的符号最少三个 多了不限制


5.字体

字体样式一共四种:斜体 粗体 粗斜体 删除线

斜体

内容两侧使用一个星号*或者一个下划线_

*一个人站不住*

_一个人站不住_

显示效果为:
在这里插入图片描述

粗体

内容两侧使用两个星号*或者两个下划线_


**两个人开起来粗**

__两个人开起来粗__

显示效果为:
在这里插入图片描述

斜粗体

内容两侧使用三个星号*或者三个下划线_

***三个人又斜又粗***

___三个人又斜又粗___

显示效果为:
在这里插入图片描述

删除线

内容两侧使用两个波浪线~~

南风老师你来看,这个花裤衩不要~~998~~,不要~~98~~,只要9.8,高高兴兴穿回家!在不买就没啦!

显示效果为:

在这里插入图片描述

markdown中并不能改变字体的大小和颜色,因为那不是标准功能 ,当然如果你学过HTML大可直接用HTML源代码编写,markdown可以识别,例如:

<span style="color:yellow">花裤衩子</span>

显示效果:
在这里插入图片描述


6. 超链接

超链接分为: 内容超链接和直连超链接

内容超链接

简单的说就是显示给用户看的内容文字可以自己设定。

[点击去度娘](http://www.baidu.com)

显示效果:
在这里插入图片描述
点击去度娘

鼠标点击文字就可以打开百度页面。

直连超链接

直接超链接无法定义内容直接将链接地址暴露给用户。

<http://www.baidu.com>

显示效果:
在这里插入图片描述
http://www.baidu.com
鼠标点击文字就可以打开百度页面。

7.图片

图片分为2类:网络图片,本地图片

网络图片

![alt内容](https://www.baidu.com/img/PCtm_d9c8750bed0b3c7d089fa7d55720d6cf.png "度娘")

显示效果:

在这里插入图片描述
不要在意颜色。。。该图片为png透明图片,颜色是编辑器的背景色。

本地图片

![alt内容](./imgs/baidu.png "title内容")

显示效果:
在这里插入图片描述
与网络图片并无不同,不过需要注意的是该图片必须存在与你的电脑的指定路径中

./imgs/baidu.png 表示图片在当前文件夹下面的imgs文件夹中,名称为baidu.png

![alt内容](图片地址  "title内容")			这是图片的标准格式,下面给大家说明每个区域的作用

alt内容:图片失效的时候显示的文字 可以省略
图片地址:图片的网址或者位置
title内容:鼠标放在图片上的显示文字 可以省略


8.代码块

代码块分为2类:单行代码块和多行代码块

单行代码块

`const user = 'southwind!';`

显示效果:
在这里插入图片描述
颜色由编辑器决定!课程编辑器为VScode,黑色主题

多行代码块

多行代码块还有具体的划分,分为通用代码块与特定语言代码块

通用代码块格式

在代码的前一行和最后另起一行,使用连续的三个反引号 ` ,反引号为键盘数字1前面的~按键,按住shift

定义一个js函数

```
function user(sex){
    return sex;
}
```

显示效果
在这里插入图片描述
代码块区域会被加上特定的背景颜色,颜色由编辑器决定!
注意:如果你需要在代码块中使用markdown的代码块内容,可以在最外层多写几个反引号就行啦!一般不会遇到,除非你是老师,哈哈哈哈

在这里插入图片描述

特定语言代码块

如果你知道代码区域是什么语言编写的话,可以进行语种标记,例如

定义一个js函数

```javascript
function user(sex){
    return sex;
}
```

显示效果为:
在这里插入图片描述
定义一个python函数

```python
def  user(sex)
	return sex
```

显示效果为:
在这里插入图片描述


9.内容引用

内容引用指引用其他人的话或者文章,需要进行标注。
在需要引用的内容行最开头添加一个> 即可,>后面必须有空格

许褚:
> 谁来与我大战三百回合!~

显示效果:
在这里插入图片描述
引用也可以多行内容

许褚:
> 谁来与我大战三百回合!~
> 谁来与我大战三百回合!~
> 谁来与我大战三百回合!~
> 谁来与我大战三百回合!~

或者

许褚:
> 谁来与我大战三百回合!~
谁来与我大战三百回合!~
谁来与我大战三百回合!~
谁来与我大战三百回合!~

显示效果为:
在这里插入图片描述
如果后面内容想脱离引用也很简单,单独空出一行就好啦~!

诸葛亮:
> 观今夜天象,
知天下大事!

大哥再见! 空一行就可以脱离引用

显示效果
在这里插入图片描述

引用也可以嵌套使用

刘备:
> 我们三弟知识渊博,博古通今,经常说:
> > 俺也一样!

显示效果
在这里插入图片描述


10.锚点

锚点是作为文章中快速定位使用的格式,可以配合链接实现点击链接跳转到页面的指定位置

锚点并不需要用户特意处理,因为页面中每个标题你都会自动成为锚点,只需要设置对应的链接即可!

当前页面有很多标题了!~ 无论是1.2.3.4这样的大标题还是标题中的小标题都可以直接使用。
格式为:

[显示内容](#标题名称)

显示结果就是一个链接
在这里插入图片描述
这样我们就可以制作返回顶部,返回底部之类的链接啦~~~

对啦,注意看优快云右侧的目录哟,那里会自动生成当前文章的锚点哟,因为该文章使用markdown编写!

恭喜,到此为止我们的标准化markdown的规范就介绍完成啦,当然编辑器可能会添加的扩展功能和格式不在此处的讨论之列哟!!!

全覆盖路径规划开源项目Clean-robot-turtlebot3关键函数解析(上) 本系列文章主要介绍全覆盖路径规划开源项目Clean-robot-turtlebot3的相关内容,包含如下四篇文章,分别介绍了开源项目Clean-robot-turtlebot3流程的概括总结、ROS坐标系常用坐标及其变换、Clean-robot-turtlebot3关键函数解析等内容。 阅读详情

相关推荐

深入解析ViT中的RoPE旋转位置编码:原理、实现与视觉应用

本文深入解析了ViT中的RoPE旋转位置编码原理、实现及其在视觉任务中的应用。RoPE通过旋转变换巧妙地将相对位置信息融入注意力计算,解决了传统绝对位置编码外推性差的问题,在图像分类、目标检测及生成任务中展现出更优的泛化能力和灵活性。

alice7model的博客 706

.md文件格式详解,即markdown文件语法(图文对照),新生代农民工必备技能

对于程序员,经常用github、码云等,对于md很常见了。 Markdown 是一种轻量级标记语言,。 它允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的HTML文档。 由于 Markdown 的轻量化、易读易写特性,并且对于图片,图表、数学式都有支持,许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。 如GitHub、Reddit、Diaspora、Stack Exchange、OpenStreetMap、SourceForge、简书等,甚至还能被使用来撰写电子..

【小石头的茅坑】 80万+

cuda2 but found one of them on device cuda 0

cuda2 but found one of them on device cuda 0 上面问题的重点是,不是cpu和gpu之间的常规问题,而是出现在不同gpu之间的数据。 出问题地方: model = nn.DataParallel(model, device_ids=[2,4]) 先说解决方法: 方案一: model = nn.DataParallel(model, device_ids=[0,2,4]) 前面一定要给一个0的序号,如果0被别人占了呢? 方案二: os.environ["CUDA_

binqiang2wang 665

如何使用Markdown语言编写文档

Markdown基础语法 一、标题 使用#号标记,#号个数即为级数 # 一级标题 ## 二级标题 ... 二、段落格式 1. 字体 斜体:*斜体文本* 或 _斜体文本_ 粗体:**粗体文本** 或 __粗体文本__ 粗斜体:***粗斜体文本*** 或 ___粗斜体文本___ 样例: 斜体1 斜体2 粗体1 粗体2 粗斜体1 粗斜体2 2. 分隔线 *** 或 --- 或 ***** 或 ----- 样例: 3. 删除线 ~~删除线文本~~ 样例:haha 4. 下划线 <u>带下划.

weixin_47307539的博客 3592

统信UOS系统网络服务异常排查:WIFI图标消失与网络设置缺失的解决方案

本文详细解析了统信UOS系统WIFI图标消失与网络设置缺失的常见问题,提供了从基础修复到进阶排查的完整解决方案。重点分析了NetworkManager服务异常的根本原因,包括系统更新中断、权限配置错误等,并给出实用的命令行操作指南和预防措施,帮助用户快速恢复网络功能。

weixin_29234239的博客 619

2023-ICCV-隐式神经网络实现低光照图像增强(NeRCo)论文解读+代码解析

NeRCo()提出了一种名为NeRCo的隐式神经表示方法,用于合作式低光图像增强。现有的低光图像增强方法存在以下三个限制:不可预测的亮度降低和噪声、度量友好版本和视觉友好版本之间的固有差距,以及有限的配对训练数据。为了解决这些限制,论文提出了NeRCo方法,它以无监督的方式稳健地恢复感知友好的结果。具体而言,NeRCo通过一个可控的拟合函数统一了现实场景中多样的退化因素,从而提高了鲁棒性。对于输出结果,论文引入了来自预训练视觉-语言模型的先验信息,采用语义导向的监督方法。

weixin_45595504的博客 3184

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

Markdown的简单用法 什么是markdown     markdown 是一种文本编写的语法,它的目标是实现“易读易写”,通过简单的标记便可以实现带有格式的文本的编写,由 markdown 语法编写的文件叫做md文件。实际上,md文件中的许多格式也可以用HTML标签实现,例如,在md文件中换行效果也可以通过HTML标签 <br/> 实现,但是个人并不推荐这样做,因为在md文件中应...

qq_38287315的博客 9568

果蔬及菜品识别系统

果蔬及菜品识别系统

我的博客 2118

.md文件格式语法详解,即markdown文件语法详解(图文并茂)

一些Markdown处理器允许您创建术语及其对应定义的定义列表。要创建定义列表,请在第一行上键入术语。在下一行,键入一个冒号,后跟一个空格和定义。

【小石头的茅坑】 73万+

EDA与机器学习融合:智能优化芯片设计流程的工程实践

机器学习作为数据驱动的核心技术,通过从历史数据中学习复杂模式,实现对系统行为的预测与优化。其原理在于构建模型,将输入特征映射到目标变量,从而揭示数据背后的内在规律。在工程领域,这项技术的核心价值在于能够将专家经验转化为可量化、可复用的智能模型,显著提升自动化水平与决策效率。电子设计自动化(EDA)是芯片设计的关键支撑,传统流程高度依赖人工试错,面临参数空间巨大、优化周期长等挑战。将机器学习应用于EDA,能够构建预测模型来预估设计性能(PPA),或通过代理模型加速设计空间探索,实现智能化的设计辅助与优化。本文

weixin_30411239的博客 684

SCCM部署教程:(3)SCCM安装

这两则摘要介绍了WSUS和SCCM的安装步骤: WSUS安装:通过服务器管理器添加"Windows服务器更新服务"角色,选择SQL数据库并指定安装路径,验证数据库连接后完成安装。 SCCM安装:先运行预检工具Prereqchk.exe,选择主站点安装类型,配置语言、站点代码和名称,设置SQL数据库连接参数(保留默认端口4022),选择通信方法和系统角色(管理点和分发点),最后完成约1小时的安装过程。 两则安装指南都强调要确保数据库配置与前期准备一致,并提供了关键配置选项的说明。

小V锅的专栏 914

markdown-it基本使用

markdown-it能够将markdown语法的内容转换为html内容,这样我们使用markdown语法写的笔记,就可以转换作为网页使用了。

pscool的博客 1万+

Transformer实战(38)——视觉Transformer (Vision Transformer, ViT)

Transformer 在自然语言处理 (NLP) 领域取得了显著成就,在许多不同的任务中都表现出色。在本节中,我们将探索视觉 Transformer (Vision Transformer, ViT) 模型。正如 NLP 领域创建了多种模型一样,视觉领域也开发了多种模型,每种模型都为计算机视觉提供了新的视角。通过本节,将学习如何使用 ViT 等模型进行计算机视觉任务,了解基于 Transformer 的预训练计算机视觉模型的工作原理,以及如何针对特定任务进行微调。

盼小辉丶的博客 2869

【Markdown】让你快速无脑编写IT文档

Markdown是一种可以使用普通文本编辑器编写的轻量级标记语言,通过简单的标记语法,可以使普通文本内容具有一定的格式,可以导出为Word、PDF....等多种格式文档,Markdown文件后缀名为".md"。

InterestingIT的博客 1065

TMS_WebGMaps_1.9.8.0_Full_Source

TMS_WebGMaps_1.9.8.0_Full_Source 全源码 delphi cbuilder

怀旧版电脑GBC模拟器

再现原版GBC掌机的界面,电脑运行连游戏界面都一样大小,很怀旧,很真实,(英文版)强烈推荐,很小的文件,很难才找到的。

【新人必备】Markdown神器——markdown-it

markdown-it以其强大的解析能力和丰富的配置选项,成为Markdown文档编辑的得力助手。此外,你还可以将markdown-it与编辑器结合,实现实时预览和编辑Markdown文档的功能。markdown-it是一款功能强大的Markdown解析器,支持丰富的Markdown语法,能够轻松将Markdown文本转换为HTML格式。今天,我们将为大家介绍一款强大的Markdown解析器——markdown-it,让你轻松驾驭文档编辑,提升工作效率!四、markdown-it与其他工具的结合使用。

wujiayu31415的博客 7108

LinePhone3.2.7(android端最新版本) sip客户端

SIP客户端For android:LinePhone3.2.7(最新版本),官网地址:http://www.linphone.org/

告别混乱文档:三步编写专业的markdown-it插件使用指南

你是否曾下载过热门的markdown-it插件,却对着简陋的README抓耳挠腮?是否因文档缺失参数说明,被迫通读源码才找到隐藏功能?本文将以markdown-it的插件生态为基础,教你用标准化流程编写用户真正需要的插件文档,让你的代码从"能用"变成"好用"。 ## 一、文档结构设计:用户认知地图 ### 1.1 核心模块划分 专业的插件文档应当包含三个核心区块,形成完整的用户旅程: | ...

gitblog_00573的博客 463

win10 跳过U8环境检测的IE WebControls.rar

win10 安装u8的时候 提示IE WebControls 不通过,这个工具可以欺骗u8的检查。 跳过U8环境检测的IE WebControls。提示导入失败后,重新检测通过。

markdown-it-texmath 技术文档

markdown-it-texmath 是一个专为 Markdown 文档设计的插件,它让你能够轻松地在文档中嵌入 TeX 数学公式,并利用 KaTeX 快速渲染数学表达式。本文档旨在指导你完成从安装到使用的整个过程,并详细介绍其功能和API。 ## 安装指南 ### Node.js环境 在你的项目中使用npm来安装markdown-it-texmath及其依赖: ```bash npm i...

gitblog_01264的博客 1175

推荐使用:markdown-it-py —— 您的Markdown解析新伙伴

推荐使用:markdown-it-py —— 您的Markdown解析新伙伴 markdown-it-pyMarkdown parser, done right. 100% CommonMark support, extensions, syntax plugins & high speed. Now in Python!项目地址:https://gitcode.com/gh_mirrors/m...

gitblog_00022的博客 1492

Mathpix Markdown-it 使用教程

Mathpix Markdown-it 是一个开源项目,旨在为科学社区提供一个增强版的 Markdown 渲染工具。它支持 LaTeX 语法,特别适用于需要处理复杂数学公式、表格和化学公式的场景。Mathpix Markdown-it 通过 MathJax 渲染数学公式,并依赖 markdown-it 进行标准 Markdown 解析。 ## 2. 项目快速启动 ### 安装 你可以通过 n

gitblog_00475的博客 1232

终极markdown-it使用指南:从快速入门到精通掌握

markdown-it是一个现代化的Markdown解析器,它完全遵循CommonMark规范,同时提供了丰富的语法扩展和插件系统。这款强大的工具不仅支持100%的CommonMark标准,还具备极高的解析速度和灵活的配置选项,是处理Markdown文档的理想选择。😊 ## 🔥 快速入门:立即开始使用markdown-it 想要快速上手markdown-it?只需要几行代码就能实现Mark

gitblog_01107的博客 966

Markdown-It-Anchors:轻松为Markdown添加平滑导航锚点

Markdown-It-Anchors:轻松为Markdown添加平滑导航锚点 项目介绍 Markdown-It-Anchors 是一个高效且易用的 Markdown-it 插件,旨在自动或手动地为Markdown文档中的标题生成永久性的锚点链接。这使得在长文档内部快速导航成为可能,同时也便于外部引用特定段落。它支持自定义样式、ID前缀以及多种语言的标题 IDs,极大提升了开发者和作者在创建技术...

gitblog_00625的博客 1471

告别手动文档!markdown-it自动化API文档生成全攻略

你是否还在为开源项目的API文档维护而头疼?每次代码迭代后手动更新文档不仅耗时耗力,还容易出现注释与文档不一致的问题。本文将带你探索markdown-it项目如何通过自动化工具链,从源码注释无缝生成专业API文档,掌握这一技能后,你将彻底摆脱文档维护的烦恼。 ## 自动化文档生成的核心组件 markdown-it的文档自动化系统主要依赖两个关键文件构建而成,它们共同协作将源码注释转化为用户友好...

gitblog_00478的博客 934

doocs/md文档编写:Markdown与VuePress结合

在开源项目快速发展的今天,高质量的文档已成为项目成功的关键因素。doocs/md项目作为一个专业的微信Markdown编辑器,其技术架构和开发理念为Markdown与VuePress的结合提供了绝佳的实践案例。本文将深入探讨如何将Markdown的高效编写与VuePress的强大功能相结合,打造专业级的技术文档体系。 ## Markdown在技术文档中的核心优势 ### 简洁高效的语法结构 ...

gitblog_00225的博客 840

Mathpix Markdown-It:科学文档编辑的革命性工具

Mathpix Markdown-It 是一个专为STEM(科学、技术、工程和数学)社区设计的开源Markdown扩展库,它将LaTeX的强大数学公式支持与Markdown的简洁语法完美结合,为学术写作和技术文档编辑带来了革命性的改变。 ## 项目核心特性 ### 强大的数学公式支持 Mathpix Markdown-It 通过MathJax引擎提供完整的LaTeX数学公式渲染支持,包括:

gitblog_00470的博客 651

解析markdown_markdown-it 原理浅析

前言最近使用 markdown-it 比较多,也开发了一些插件,在这个过程中对源码进行了研读,最终写了这篇文章。需要了解细节的读者可以自行阅读文档。此文分为两个部分:原理剖析和原理应用(编写插件)。markdown-it 原理输入一串 markdown 代码,最后得到一串 html 代码,整体流程如下:我们以一个简单的例子来解释整个流程:​# 我是一个例子​ -> ​<h1>我是...

weixin_35156503的博客 1540

10分钟上手markdown-it-emoji:从安装到高级配置的快速教程

markdown-it-emoji是一款专为markdown-it解析器设计的表情符号插件,能让你在Markdown文档中轻松使用表情符号和颜文字快捷方式。本教程将带你快速掌握从基础安装到高级配置的全过程,让你的Markdown文档更加生动有趣! ## 快速安装:3种简单方法 ### npm安装(推荐) 最便捷的安装方式是使用npm包管理器: ```bash npm install mar

gitblog_01102的博客 705
下一篇: markdown编辑工具推荐
meetcoding
博客等级 码龄5年 14粉丝 7原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明:

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

余额充值