我的学习笔记 我的学习笔记
首页
  • 本站介绍
  • 复原工程简介
  • 计算机基础

    • Windows基础
    • Linux基础
  • MC基础

    • Minecraft简介
    • 客户端
    • 服务端
  • 开服指南

    • 服务器核心
    • 服务器代理
  • 常用插件与模组

    • 客户端
    • 服务端
  • 编程语言

    • Java
    • C++
    • Python
    • JavaScript
  • 专业课程

    • 数据结构
    • 计算机操作系统
    • 数据库系统
    • 计算机网络
    • 算法设计与分析
    • 软件测试
  • 准备

    • Git使用
    • 文档写作
    • 编程规范
  • 原版开发

    • 资源包
    • 数据包
  • 非原版开发

    • 模组
    • 插件
  • 建模

    • Blockbench
    • Blender
    • 3dsMAX
    • ContextCapture
  • 动画

    • Blockbuster
    • Lumion
  • 文档编写

    • NotePad++
    • Typora
  • 网络工具

    • Frp
    • Nginx
  • LingCat-bot/灵喵
  • 复原工程Forge版mod
  • 复原工程Fabric版mod
  • jmc2obj模型导出
  • 洞穴与山崖数据包
  • 虚拟校园

    • 操作指南
  • 个人介绍
  • 友情链接
  • 鸣谢
GitHub (opens new window)
首页
  • 本站介绍
  • 复原工程简介
  • 计算机基础

    • Windows基础
    • Linux基础
  • MC基础

    • Minecraft简介
    • 客户端
    • 服务端
  • 开服指南

    • 服务器核心
    • 服务器代理
  • 常用插件与模组

    • 客户端
    • 服务端
  • 编程语言

    • Java
    • C++
    • Python
    • JavaScript
  • 专业课程

    • 数据结构
    • 计算机操作系统
    • 数据库系统
    • 计算机网络
    • 算法设计与分析
    • 软件测试
  • 准备

    • Git使用
    • 文档写作
    • 编程规范
  • 原版开发

    • 资源包
    • 数据包
  • 非原版开发

    • 模组
    • 插件
  • 建模

    • Blockbench
    • Blender
    • 3dsMAX
    • ContextCapture
  • 动画

    • Blockbuster
    • Lumion
  • 文档编写

    • NotePad++
    • Typora
  • 网络工具

    • Frp
    • Nginx
  • LingCat-bot/灵喵
  • 复原工程Forge版mod
  • 复原工程Fabric版mod
  • jmc2obj模型导出
  • 洞穴与山崖数据包
  • 虚拟校园

    • 操作指南
  • 个人介绍
  • 友情链接
  • 鸣谢
GitHub (opens new window)
  • 准备

    • Git使用
    • 文档写作
      • 一、标题
      • 这是二级标题
        • 这是三级标题
      • 二、字体
      • 三、引用
      • 四、分割线
      • 五、图片
      • 六、超链接
      • 七、列表
        • 无序列表
        • 有序列表
        • 列表嵌套
      • 八、表格
      • 九、代码
      • 十、流程图
    • 编程规范
  • 原版开发

  • 非原版开发

  • 建模

  • 动画

  • 开发指南
  • 准备
NPUcraft
2021-10-23

文档写作

Markdown是一种纯文本格式的标记语言。通过简单的标记语法,它可以使普通文本内容具有一定的格式。

优点: 1、因为是纯文本,所以只要支持Markdown的地方都能获得一样的编辑效果,可以让作者摆脱排版的困扰,专心写作。 2、操作简单。

缺点: 1、需要记一些语法(当然,是很简单。五分钟学会)。 2、有些平台不支持Markdown编辑模式。

开启方式:设置->默认编辑器->Markdown编辑器

# 一、标题

在想要设置为标题的文字前面加#来表示 一个#是一级标题,二个#是二级标题,以此类推。支持六级标题。

注:一般在#后跟个空格再写文字。

示例:

# 这是一级标题
## 这是二级标题
### 这是三级标题
#### 这是四级标题
##### 这是五级标题
###### 这是六级标题
1
2
3
4
5
6

效果如下:

# 这是一级标题

# 这是二级标题

# 这是三级标题

# 这是四级标题

# 这是五级标题
# 这是六级标题

# 二、字体

加粗 要加粗的文字左右分别用两个*号包起来

斜体 要倾斜的文字左右分别用一个*号包起来

斜体加粗 要倾斜和加粗的文字左右分别用三个*号包起来

删除线 要加删除线的文字左右分别用两个~~号包起来

示例:

**这是加粗的文字**
*这是倾斜的文字*`
***这是斜体加粗的文字***
~~这是加删除线的文字~~
1
2
3
4

效果如下:

这是加粗的文字 这是倾斜的文字` 这是斜体加粗的文字 这是加删除线的文字

# 三、引用

在引用的文字前加>即可。引用也可以嵌套,如加两个>>三个>>> n个... 貌似可以一直加下去,但没神马卵用

示例:

>这是引用的内容
>>这是引用的内容
>>>>>>>>>>这是引用的内容
1
2
3

效果如下:

这是引用的内容

这是引用的内容

这是引用的内容

# 四、分割线

三个或者三个以上的 - 或者 * 都可以。

示例:

---
----
***
*****
1
2
3
4

效果如下:

可以看到显示效果是一样的。





# 五、图片

语法:

![图片alt](图片地址 ''图片title'')

图片alt是显示在图片下面的文字,相当于对图片内容的解释。
图片title是图片的标题,当鼠标移到图片上时显示的内容(title可加可不加)。
1
2
3
4

示例:

![NPUcraft Logo](http://wiki.mualliance.ltd/muawiki/index.php/%E6%96%87%E4%BB%B6:%E6%9C%8D%E5%8A%A1%E5%99%A8%E7%AB%96%E7%89%88%E5%85%A8%E9%BB%91.png "NPUcraft")
1

效果如下:

NPUcraft Logo

上传本地图片直接点击导航栏的图片标志,选择图片即可

markdown格式追求的是简单、多平台统一。那么图片的存储就是一个问题,需要用图床 (opens new window),提供统一的外链,这样就不用在不同的平台去处理图片的问题了。才能做到书写一次,各处使用。

# 六、超链接

语法:

[超链接名](超链接地址 "超链接title")
title可加可不加
1
2

示例:

[NPUcraftWiki](https://wiki.npucraft.com)
[MUAWiki](http://wiki.mualliance.ltd)
[NPUcraft-Github](https://github.com/npucraft)
1
2
3

效果如下:

NPUcraftWiki (opens new window)

MUAWiki (opens new window)

NPUcraft-Github (opens new window)

注:Markdown本身语法不支持链接在新页面中打开,VuePress做了自动处理,是可以的。别的平台可能就不行了,如果想要在新页面中打开的话可以用html语言的a标签代替。

<a href="超链接地址" target="_blank">超链接名</a>

示例:
<a href="https://www.npucraft.com" target="_blank">NPUcraft</a>
1
2
3
4

# 七、列表

# 无序列表

语法:

无序列表用 - + * 任何一种都可以

- 列表内容
+ 列表内容
* 列表内容
1
2
3

注意:- + * 跟内容之间都要有一个空格

效果如下:

  • 列表内容
  • 列表内容
  • 列表内容

# 有序列表

语法:

数字加点

1. 列表内容
2. 列表内容
3. 列表内容
1
2
3

注意:序号跟内容之间要有空格 效果如下:

  1. 列表内容
  2. 列表内容
  3. 列表内容

# 列表嵌套

上一级和下一级之间敲三个空格即可

  • 一级无序列表内容

    • 二级无序列表内容
    • 二级无序列表内容
    • 二级无序列表内容
  • 一级无序列表内容 1.二级有序列表内容 2.二级有序列表内容 3.二级有序列表内容

1.一级有序列表内容

  • 二级无序列表内容
  • 二级无序列表内容
  • 二级无序列表内容

2.一级有序列表内容 1.二级有序列表内容 2.二级有序列表内容 3.二级有序列表内容

# 八、表格

语法:

表头|表头|表头
---|:--:|---:
内容|内容|内容
内容|内容|内容

第二行分割表头和内容。
- 有一个就行,为了对齐,多加了几个
文字默认居左
-两边加:表示文字居中
-右边加:表示文字居右
注:原生的语法两边都要用 | 包起来。此处省略
1
2
3
4
5
6
7
8
9
10
11

示例:

姓名|技能|排行
--|:--:|--:
刘备|哭|大哥
关羽|打|二哥
张飞|骂|三弟
1
2
3
4
5

效果如下:

姓名 技能 排行
刘备 哭 大哥
关羽 打 二哥
张飞 骂 三弟

# 九、代码

语法:

单行代码:代码之间分别用一个反引号包起来

`代码内容`
1

代码块:代码之间分别用三个反引号包起来,且两边的反引号单独占一行

(```)这个地方写编程语言名称,可以不加
  代码...
  代码...
  代码...
(```)
1
2
3
4
5

注:为了防止转译加了小括号,实际中括号删掉。

示例:

单行代码

`create database hero;`
1

代码块

(```)
    function fun(){
         echo "这是一句非常牛逼的代码";
    }
    fun();
(```)
1
2
3
4
5
6

效果如下:

单行代码

create database hero;

代码块

    function fun(){
         echo "这是一句非常牛逼的代码";
    }
    fun();
1
2
3
4

# 十、流程图

st=>start: 开始
op=>operation: My Operation
cond=>condition: Yes or No?
e=>end
st->op->cond
cond(yes)->e
cond(no)->op
1
2
3
4
5
6
7

效果如下:

flow

st=>start: Start

op=>operation: Your Operation

cond=>condition: Yes or No?

e=>end

st->op->cond

cond(yes)->e

cond(no)->op

改编自:

作者:高鸿祥

链接:https://www.jianshu.com/p/191d1e21f7ed

来源:简书

著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。

上次更新: 2021/10/30, 01:49:55

← Git使用 编程规范→

Theme by Vdoing | Copyright © 2021-2022 NPUcraft

蜀ICP备2020036244号-2

    

川公网安备 51010802001175号

  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式