CrossDown/README.md

201 lines
2.4 KiB
Markdown
Raw Normal View History

2024-09-08 10:20:05 +08:00
# CrossDown
自制的markdown添加了一些自定义的语法
2024-09-08 21:24:40 +08:00
效果请见[README.html](https://github.com/CrossDark/CrossDown/blob/main/README.html)
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
1 基本语法
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
1.1 标题
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
1.2 样式
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
1.2.1 *斜体*
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
1.2.2 **粗体**
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
1.2.3 ***粗斜体***
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
1.2.4 ~下划线~
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
1.2.5 ~~删除线~~
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
1.2.6 ==高亮==
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
1.2.7 [在文本的正上方添加一行小文本]^(主要用于标拼音)
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
1.2.8 [在指定的文本里面隐藏一段文本]-(只有鼠标放在上面才会显示隐藏文本)
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
1.2.9 分割线
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
---
___
***
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
1.3 链接
2024-09-24 19:27:03 +08:00
2024-09-08 22:15:57 +08:00
1.3.1 普通链接
2024-09-24 19:27:03 +08:00
2024-09-08 22:15:57 +08:00
[链接文本](链接地址)
2024-09-24 19:27:03 +08:00
2024-09-08 22:15:57 +08:00
[CrossDark](https://crossdark.com)
2024-09-24 19:27:03 +08:00
<https://crossdark.net/>
2024-09-08 22:15:57 +08:00
1.3.2 图片
2024-09-24 19:27:03 +08:00
2024-09-08 22:15:57 +08:00
![链接图片](链接地址)
2024-09-24 19:27:03 +08:00
2024-09-15 20:59:19 +08:00
![sea](https://crossdark.com/wp-content/uploads/2024/05/1715259682-sea.jpg)
2024-09-24 19:27:03 +08:00
2024-09-17 10:39:01 +08:00
1.3.3 变量链接
2024-09-24 19:27:03 +08:00
2024-09-17 10:39:01 +08:00
[链接文本][变量]
2024-09-24 19:27:03 +08:00
2024-09-17 10:39:01 +08:00
[变量]: https://crossdark.com
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
2 变量
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
2.1 定义
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
{变量名} = 值
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
2.2 赋值
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
{变量名} {锚点名}
2024-09-24 19:27:03 +08:00
2024-09-17 10:39:01 +08:00
提纲的编号已经自动配置为了锚点,可直接使用{2}
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
2.3 添加锚点
2024-09-24 19:27:03 +08:00
2024-09-08 22:22:30 +08:00
{#锚点名}
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
3 代码块
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
3.1 `单行`
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
3.1.1 LaTex
2024-09-24 19:27:03 +08:00
2024-09-08 22:15:57 +08:00
`$CO_2$`
2024-09-24 19:27:03 +08:00
2024-09-17 10:39:01 +08:00
`$H_2O$`
2024-09-24 19:27:03 +08:00
2024-09-22 19:44:35 +08:00
3.1.2 函数
2024-09-24 19:27:03 +08:00
2024-09-22 19:44:35 +08:00
`¥y=x*2+1¥` // 不定义范围
2024-09-24 19:27:03 +08:00
2024-09-22 19:44:35 +08:00
`¥y=x**2¥€-50,50€` // 定义了x范围
2024-09-24 19:27:03 +08:00
2024-09-22 19:44:35 +08:00
`¥y=x**3¥€-50,50|-100,100€` // 定义了y范围
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
3.2 多行
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
3.2.1 YAML
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
`
A:
1. a
2. b
3. c
B:
- a
- b
- c
`
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
3.2.2 Python
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
`python
print('CrossDown')
`
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
3.2.3 Mermaid
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
`mermaid
graph LR
A-->B
A-->C
B-->D
C-->D
`
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
4 转义
2024-09-24 19:27:03 +08:00
2024-09-08 22:22:30 +08:00
\\
2024-09-24 19:27:03 +08:00
2024-09-08 22:22:30 +08:00
\a
2024-09-24 19:27:03 +08:00
2024-09-08 22:22:30 +08:00
\*
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
5 引用
2024-09-24 19:27:03 +08:00
2024-09-17 10:45:26 +08:00
> 一级引用
>> 二级引用
>>> 三级引用
>>>> 四级引用
>>>>> 五级引用
>>>>>> 六级引用
>
> 引文内添加*斜体***粗体**~下划线~~~删除线~~==高亮==
2024-09-15 20:59:19 +08:00
2024-09-07 19:55:44 +08:00
6 提纲
2024-09-24 19:27:03 +08:00
2024-09-22 12:42:46 +08:00
6.1 提纲号
2024-09-24 19:27:03 +08:00
2024-09-22 12:42:46 +08:00
以数字和点组成,通过空格与提纲名分隔,例如:
2024-09-24 19:27:03 +08:00
2024-09-22 12:42:46 +08:00
6.1.1 提纲号示例
2024-09-24 19:27:03 +08:00
2024-09-22 12:42:46 +08:00
点不能出现在开头或结尾,例如
2024-09-22 12:48:28 +08:00
2024-09-22 12:42:46 +08:00
.6.1.2 错误示范
2024-09-22 12:48:28 +08:00
2024-09-22 12:42:46 +08:00
6.1.3. 错误示范
2024-09-22 12:48:28 +08:00
2024-09-22 19:58:48 +08:00
不能出现两个及以上连续的点,例如:
6..1...4 错误示范
2024-09-22 12:48:28 +08:00
提纲号会被自动配置为锚点,可直接使用{6}{6.1}
2024-09-07 19:55:44 +08:00
7 注释
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
7.1 强注释
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
|=
无论如何都会被移除
`放在代码块里也没用`
=|
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
7.2 弱注释
2024-09-24 19:27:03 +08:00
2024-09-07 19:55:44 +08:00
只有在 // 后面才会被移除
2024-09-24 19:27:03 +08:00
2024-09-08 22:15:57 +08:00
`// 代码中的注释弱不会被移除`
2024-09-24 19:27:03 +08:00
2024-09-15 20:59:19 +08:00
8 列表
2024-09-24 19:27:03 +08:00
2024-09-15 20:59:19 +08:00
8.1 有序列表
1. a
2. b
3. c
4. d
8.2 无序列表
- A
- B
- C
- D
2024-09-17 10:39:01 +08:00
9 表格
2024-09-24 19:27:03 +08:00
| 表头1 | 表头2 | 表头3 |
|:----:|:----:|:----:|
2024-09-17 10:39:01 +08:00
| 单元格1 | 单元格2 | 单元格3 |
| 单元格4 | 单元格5 | 单元格6 |