md文档使用小技巧

简介

在日常写readme文档中,可能会遇到一些小问题,此处记录一下md文档编写过程中的一些小技巧。

插入图片

在md文档中插入图片,目前有三种方式,本地导入、网络导入、base64导入。

本地导入

非常依赖与本地,无法脱机显示,不建议使用

![avatar](/home/picture/1.png)

网络导入

需要事先将图片上传到网络并生成一个链接,在编写时较为简易方便

![avatar](http:// *)

base64导入

需要事先将对应图片转换成base64编码,再插入到对应位置即可,但base64编码较为臃肿,因此建议将base64编码放置于最后

普通写法

![avatar](data:image*)

建议写法

![avatar][img]

[img]:data:image*

注意事项:
在md文档使用base64进行编码时,需要注意图片引用与其他的内容中间需要添加空格,否则无法正常识别。
另:base64转码已使用python,需要可查看python编码

无序列表、有序列表

使用* 来声明无序列表, 使用序号1.等展示有序列表

md文档的下划线问题

可以将需要展示的字符串被 包围即可,例如__new__

表格插入

数据1 数据 2
数据1 数据2
数据1 数据2
| 数据1 | 数据 2|
| ---- | ---- |
| 数据1 | 数据2 |
| 数据1 | 数据2 |

想在表格中添加|

只需要在|前添加\即可完成转义

posted @   形同陌路love  阅读(1283)  评论(0编辑  收藏  举报
相关博文:
阅读排行:
· 分享一个免费、快速、无限量使用的满血 DeepSeek R1 模型,支持深度思考和联网搜索!
· 基于 Docker 搭建 FRP 内网穿透开源项目(很简单哒)
· ollama系列01:轻松3步本地部署deepseek,普通电脑可用
· 25岁的心里话
· 按钮权限的设计及实现
点击右上角即可分享
微信分享提示