基础贡献

此Wiki使用Vitepress搭建，文章主要使用Markdown书写，同时支持 $L A T E X$ 、HTML、CSS和JavaScript。

由于此文章是基础贡献，所以没有涉及到Github项目流程，写好文章后无法自行上传，请将文件（Markdown、Work皆可）、图片（请标明好图片插入的位置）等资源发给1352862815@qq.com 或QQ群1108024910联系Cure。

更复杂内容请查看进阶贡献

本教程参考自NCEPUwiki-基础贡献

通过文章贡献

创建Markdown文件

你可以在本地创建一个txt文件，然后将后缀改为.md。

你也可以在网络上搜索“在线Markdown”，找到你喜欢的网站如 https://www.markdownassistant.com/zh/，写好后导出到本地为.md文件

文章结构

文章由两部分组成

Frontmatter
正文

Frontmatter

Frontmatter是文章的一些基本信息，必须在Markdown文件的顶部，并且被包裹在一对三短划线中间。示例：

---
title: 基础贡献
description: 向NKUwiki投稿的基础指南：Markdown写作规范、文章Frontmatter字段、标题图片表格等语法，以及内容提交方式。
date: 2026-09-10
lastUpdated: 2026-09-14
author:
  - name: Cure
categories:
  - 贡献
    - 测试
tags:
  - 基础贡献
  - 测试
permalink: /pages/BasicContribution/
---

此Wiki常用Frontmatter内容即为以上内容

title 会在正文开头生成一个1级标题，会覆盖掉手动写的一级标题，所以你可以不单独写1级标题
description 该文章的简介
date 为文章创建日期，格式为 YYYY-MM-DD，后续修改时保留。
lastUpdated 为最近一次内容更新日期，格式为 YYYY-MM-DD。新增、删除或修正正文信息、文字勘误、措辞修改，以及补充或修复有效资料链接时，在同一个提交中手动更新此字段；修改文章引用的脑图或组件中的实际内容时也需同步更新。纯排版、分类、SEO 元数据、文件迁移和等价的组件替换不更新日期。
新文章只填 date；有后续内容更新时再添加 lastUpdated。未填写时不显示页尾更新时间，也不进入“最近更新”列表。构建时不会从 Git 自动生成日期，普通目录和归档仍可按创建日期展示文章。
author 文章作者，可不写：页尾的「本文作者」只按这里列出的作者展示，不写则显示默认的NKUwiki-Group，索引卡片同样如此。写法见下节「作者与头像」。
categories 即为文章分类，可以多次缩进表示嵌套（子目录）
tags 即为标签
短横线“-”，使用tab缩进。
一般情况下categories和.md文件所在目录相对应，具体可参考同目录文件的写法。
permalink 可以不写，会自动生成链接。但是建议写，以固定文章链接

更多内容请查看https://vitepress.dev/zh/guide/frontmatter

作者与头像

作者从哪里来

文章页尾的「本文作者」只取 frontmatter 的 author 字段，按声明顺序列出。

author 的写法

只支持一种写法：数组，元素是 { name, email, avatar } 对象；只有一个作者时也这样写。

author:
  - name: Cure
    email: mailto:1352862815@qq.com
  - name: NKUwiki
    avatar: https://example.com/avatar.png

每个元素的字段：

字段	必填	说明
name	是	显示的名字；缺了这一条会被忽略
email	否	写 `a@b.com` 或 `mailto:a@b.com` 都行，仅用于展示
avatar	否	头像图片地址，例如 `https://example.com/avatar.png`；填了就直接用

写法约束

必须是数组：author: Cure、author: { name: Cure }、数组里直接写名字字符串，这些写法都不再支持，会被忽略。
键名是 author（单数）。页面数据里的 authors 是构建时生成的内部字段，写在 md 里无效。
名字本身带空格没问题，会整体当作一个名字；多个作者就写多个数组元素。
如下写法会被忽略：author: 空值、字符串、数字、嵌套数组，以及没有 name 的元素。
名字或邮箱里有 : 、#，或开头是 @、?、&、* 这类 YAML 特殊字符时，用引号包起来，例如 email: "mailto:a@b.com"。

头像与兜底

页尾顺序：完全按 frontmatter 里声明的顺序，不做自动排序或去重；同一个人写两次就会出现两条。
头像推导顺序：avatar → 姓名首字生成的本地头像；avatar 填了但图片加载失败时也会回退到首字头像。
首字头像由姓名生成（首字 + 由姓名决定的稳定色相），不请求任何外部头像服务，离线时也能显示。
没写 author 时页尾显示 NKUwiki-Group，链接 https://github.com/NKUwiki/NKUwiki，头像用姓名首字生成的本地头像。
索引和归档卡片显示 frontmatter 里的名字（多个作者用「、」连接）；完全没写 author 时卡片才回退显示 NKUwiki-Group。

Markdown 语法

Markdown 的基础语法——标题、段落、加粗与斜体、列表、链接、图片、表格，以及本站特有的卡片组件与图标短码——已经整理成独立文章：Markdown语法。

写正文之前建议先看一遍，正文里会用到。

你可以查看本文章，并参考写作。

通过飞书贡献

欢迎您使用飞书云文档进行NKUwiki的编写工作。
在左侧栏有新生入学，浅谈学习，群汇总，校园生活四个分区，您可以在其中修订文章或者新增篇目。
由于我不会经常登录飞书进行文档的查阅，所以如果您对文档有所更改，欢迎进入NKUwiki的项目组QQ群（1108024910）进行反馈，或者联系我的个人邮箱说明情况（1352862815@qq.com）
反馈时请说明修改时间，修改人名称和修改内容

基础贡献 ​

通过文章贡献 ​

创建Markdown文件 ​

文章结构 ​

Frontmatter ​

作者与头像 ​

作者从哪里来 ​

author 的写法 ​

写法约束 ​

头像与兜底 ​

Markdown 语法 ​

通过飞书贡献 ​