md文档语法大全

目录

基本符号

标题

# + 文字

# + 文字+ #

列表

无序列表

有序列表

嵌套列表

引用块

行引用

嵌套引用

代码块

链接

图片

分割线

表格

复选框

换行

其他


基础不牢,地动山摇,好的文档是项目质量及后续可维护的一个重要因素,每次写md文档时,总是提笔忘字,下决心一次弄明白。觉得有帮助,记得收藏点赞~

基本符号

md文档中基本标记都是基于 * - +. > 这几个符号的组合操作。注意符号后面都要有一个用于分割符号与内容的空格。

标题

# + 文字

# 标题1 #
## 标题2 ##
### 标题3 ###
#### 标题4 ####
##### 标题5 #####
###### 标题6 #######

效果图

最多到6级标题

# + 文字+ #

# 标题1 #
## 标题2 ##
### 标题3 ###
#### 标题4 ####
##### 标题5 #####
###### 标题6 #######

效果同上

注意:标题1和标题2下默认有条横线

列表

无序列表

+ a
+ b
+ c

- d
- e
- f

* g
* h
* i

效果图

有序列表

有序列表
1. abc
2. abc
3. dada

错序列表
2. awfa
5. awef
25. dfaf

效果图

嵌套列表

无序
+ a
  + a1
  + a2
+ ba
+ c

有序
1. a
   1. adac
      1. adaw
   2. adfsda
2. ad
3. sad

效果图

引用块

行引用

引用
> adsadfafadfae  aef ae 
a ef a fae q3ef 

嵌套引用
> awd aw
>> a 

效果图

嵌套引用

引用
> 引用1
引用1 引用1
 

嵌套引用
> 嵌套引用1 
>> 嵌套引用1 

效果图

代码块

代码块
`
adaawf
`
多行代码块儿
```
adaawfwrfwr
```

效果图

链接

//链接
[百度1](www.baidu.com)

效果图

图片

![图片](https://note.youdao.com/favicon.ico)

效果图

分割线

分割线
---
- - -
-------
*****
* * *
____

效果图

表格

表格
|123|234|345|
|:-|:-:|-:|
|abc|bcd|cde|
|abc|bcd|cde|
|abc|bcd|cde|
|abc|bcd|cde|
|abc|bcd|cde|
//例子二
|123|234|345|
|:---|:---:|---:|
|abc|bcd|cde|
|abc|bcd|cde|
|abc|bcd|cde|
//例子三
123|234|345
:-|:-:|-:
abc|bcd|cde
abc|bcd|cde
abc|bcd|cde

效果图

注意:斑马线为默认显示的

复选框

- [ ] 复选框
- [x] 选中状态

效果图

换行

本行后边加两个空格

其他

//斜体
*md*

//粗体
**md**

//斜体
_md_

//斜体
__md__

//转义

\+

//删除线

~~删除~~

效果图

### 关于SQL语法大全的Markdown文档 对于SQL语法大全以及其对应的Markdown格式文档,目前并没有官方统一的标准文档可以直接下载。然而,可以通过一些开源项目或者社区资源来获取类似的资料。 一种方法是从GitHub上的相关项目中寻找已有的实现。例如,在`sql2Markdown`这个项目中[^1],提供了将SQL文件转换为Markdown表结构文档的功能。虽然该项目本身并不是直接提供SQL语法的手册,但它可以作为一个工具帮助整理和生成SQL相关的文档。 如果需要更详细的SQL语法规则描述,可以参考MySQL、PostgreSQL或其他数据库厂商提供的官方文档,并将其内容手动转化为Markdown格式。以下是几个可能有帮助的方向: - **MySQL 官方文档**:涵盖了完整的SQL语法定义,适合用于学习和查询具体命令用法。 - **PostgreSQL 文档**:同样详尽地记录了标准SQL及其扩展功能。 另外需要注意的是,在编写涉及HTML实体字符的内容到Markdown时,某些特殊符号如 `&`, `<`, `>` 等会被自动转换为其相应的HTML实体形式[^2]。因此当准备此类技术文档时要特别留意这些细节以免影响最终呈现效果。 下面给出一段简单的Python脚本作为例子展示如何解析基本的CREATE TABLE语句并输出成Markdown表格样式: ```python def sql_to_markdown(sql): lines = [] parts = sql.split('(', 1)[1].rsplit(')', 1)[0].split(',') for part in parts: fields = [item.strip() for item in part.strip().split()] name, type_ = fields[:2] desc = ' '.join(fields[2:]) if len(fields) > 2 else '' lines.append(f"| {name} | {type_} | {desc} |\n") header_line = "| Column Name | Data Type | Description |\n" separator_line = "|------------|-----------|-------------|\n" return ''.join([header_line, separator_line]+lines) example_sql = """CREATE TABLE example ( id INT PRIMARY KEY, username VARCHAR(50), email TEXT UNIQUE NOT NULL );""" print(sql_to_markdown(example_sql)) ``` 此函数接受一条创建表的SQL指令字符串参数,返回值是一个按照指定列布局排列好的Markdown格式化后的文本串表示该张数据表的信息概览情况。
评论 4
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值