基础贡献
此Wiki使用Vuepress的Vdoing搭建,文章主要使用Markdown书写,同时支持
由于此文章是基础贡献,所以没有涉及到Github项目流程,写好文章后无法自行上传,请将文件、图片等资源发给[email protected]或QQ群 417695180 联系 鹰仓茉子
更复杂内容请查看进阶贡献
文章书写
创建Markdown文件
你可以在本地创建一个txt文件,然后将后缀改为md
你也可以在网络上搜索“在线Markdown”,找到你喜欢的网站如https://metool.online/zh/markdown/edit/,写好后导出到本地为 .md 文件
文章结构
文章由两部分组成
- Frontmatter
- 正文
Frontmatter
Frontmatter是文章的一些基本信息,必须在 Markdown 文件的顶部,并且被包裹在一对三短划线中间。示例:
---
title: 基础贡献
date: 2025-09-16
lastUpdated: 2026-09-14
author: 鹰仓茉子
categories:
- 贡献
- 测试
tags:
- 基础贡献
- 测试
permalink: /pages/BasicContribution/
---此Wiki常用Frontmatter内容即为以上内容
- permalink 可以不写,会自动生成链接。但是建议写,以固定文章链接。
- author 有默认值,可不写默认为NCEPUwiki-Group
- date 为文章创建日期,格式为 YYYY-MM-DD,后续修改时保留。
- lastUpdated 为最近一次内容更新日期,格式为 YYYY-MM-DD。新增、删除或修正正文信息、文字勘误、措辞修改,以及补充或修复有效资料链接时,在同一个提交中手动更新此字段;修改文章引用的脑图或组件中的实际内容时也需同步更新。纯排版、分类、SEO 元数据、文件迁移和等价的组件替换不更新日期。
- 新文章只填 date;有后续内容更新时再添加 lastUpdated。未填写时不显示页尾更新时间,也不进入“最近更新”列表。构建时不会从 Git 自动生成日期,普通目录和归档仍可按创建日期展示文章。
- title 会在正文开头自动生成1级标题,所以正文里可以不写一级标题;如果你在正文里单独写了一级标题(
# 标题),则以你写的为准,不会再自动生成 - categories 可以多次缩进表示嵌套(子目录)
- categories 和 tags 的短横线“-”,使用tab缩进。
- 一般情况下 categories 和 md 文件所在目录相对应,具体可参考同目录文件的写法。
更多内容请查看https://vitepress.dev/zh/guide/frontmatter
基础语法
Markdown可以看做是有点文字样式和排版的TXT文本文件,因此学习很快,门槛极低。
这里将会介绍基础的Markdown语法,学会后即可撰写简单的文章。
此Wiki常用Markdown语法有:
标题
使用英文井号'#' + 空格 + 文字,单独占一行,几个'#'表示几级标题,支持1到6级标题。一级标题可以省略:正文里没写一级标题时会自动用 frontmatter 的 'title' 生成,自己写了一级标题则以自己写的为准。标题前后请留一行空行。
- 1级标题
# H1 - 2级标题
## H2 - 6级标题
###### H6
段落
Markdown一段文字就是一个段落,要创建新段落,请至少回车两次,保证两段文字之间至少有一个空行。也可以使用HTML语法</br>换行(非必要不建议)。
加粗与斜体
使用两对英文星号表示加粗,如\*\*加粗内容\*\*
使用一对英文星号表示斜体,如\*斜体内容\*
列表
列表有有序和无序之分
有序列表使用 阿拉伯数字 + 英文句号'.' + 空格实现。数字可以不连续,Markdown会自动修正数字顺序。嵌套使用TAB键,或者加三个空格。
- 列表1
- 列表2
- 列表3
- 列表4
- 列表5
- 列表3
- 列表6
1. 列表1
2. 列表2
1. 列表3
1. 列表4
2. 列表5
3. 列表6无序列表使用 英文短横线'-' + 空格实现。一个短横线表示一个点。嵌套列表请在开头加两个空格
- 无序列表1
- 无序列表2
- 无序列表2.1
- 无序列表2.2
- 无序列表3
- 无序列表2.2
- 无序列表1
- 无序列表2
- 无序列表2.1
- - 无序列表2.2
- 无序列表3有序和无序可嵌套,一般用TAB或者打出和上一级标题相同长度的空格。有序标题是3个空格,无序标题是2个空格。
- 主要任务
- 子任务A
- 子任务B
- 详细步骤1
- 详细步骤2
- 子任务C
- 次要任务
1. 主要任务
- 子任务A
- 子任务B
1. 详细步骤1
2. 详细步骤2
- 子任务C
2. 次要任务链接
WIki内部资料引用为相对路径,即 Frontmatter 的 permalink ,或者是网址https://wiki.ncepuinfo.cc/pages/books_bd_donglixi/中https://wiki.ncepuinfo.cc后面的部分,如`/pages/BasicContribution/`
[链接名称](链接地址)
[链接文字](链接地址 "可选的标题")
<链接地址>
[百度](www.baidu.com "百度一下你就知道")
[入学准备](/pages/Preparation)
[动力工程系教材与资料](/pages/books_bd_donglixi/)插入图片
Markdown 图片语法格式如下:

由于Markdown不支持图片大小设置,所以有时候会使用HTML的<img>标签。
本网站所有图片相对路径为\img\,也可以引用外部网络图片。
表格
一个最简单的表格由表头行、分隔行和数据行组成,列与列之间用英文竖线 | 分隔,行首和行尾也各写一个 | 方便对齐。
| A列 | B列 | C列 |
|---|---|---|
# 标题 | 一级标题 | 标题 |
**文字** | 加粗 | 文字 |
*文字* | 斜体 | 文字 |
[文字](链接) | 插入链接 | 百度 |
| 语法 | 作用 | 效果 |
| --- | --- | --- |
| `# 标题` | 一级标题 | 标题 |
| `**文字**` | 加粗 | **文字** |
| `*文字*` | 斜体 | *文字* |
| `[文字](链接)` | 插入链接 | [百度](https://www.baidu.com) |第二行的分隔行使用短横线 -,还可以配合冒号 : 控制每一列的对齐方式:
:---左对齐(默认):---:居中对齐---:右对齐
| 左对齐 | 居中 | 右对齐 |
|---|---|---|
| 1 | 2 | 3 |
| 左对齐 | 居中 | 右对齐 |
| :--- | :---: | ---: |
| 1 | 2 | 3 |单元格内同样可以使用加粗、斜体、链接等行内语法;如果需要在单元格内换行,可以使用 HTML 标签 </br>。
注意事项:
- 竖线、短横线、冒号都要使用英文符号,行首和行尾的竖线可以省略,但建议写上。
- 每一行的单元格数量最好保持一致,否则表格可能显示错乱。
- 表格前后请留一个空行,否则可能无法被正确识别为表格。
其他
更多语法如代码、引用块、图表绘制等请参考Markdown、菜鸟网站,进行系统学习。
HTML等前端内容较深入,且使用频率低,请自行学习。
你可以查看此wiki的github文章,参考写作https://github.com/NCEPUwiki/NCEPUwiki/blob/main/docs/01.新生入学/01.新生-入学准备.md?plain=1


