本文主要介绍一些适用于本网站写作常用的基础语法与格式。如果想要系统学习Markdown语法,可以去下列网站学习,一些最基础的用法,这里就不再赘述。
Markdown 教程
描述: Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。
来源: 菜鸟教程
GitHub 仓库卡片
这里可以添加链接到 GitHub 仓库的动态卡片,在页面加载时,仓库信息会从 GitHub API 中拉取。
使用代码 ::github{repo="AbabCat927/AbabCat927.github.io"} 创建一个 GitHub 仓库卡片。
::github{repo="AbabCat927/AbabCat927.github.io"}警告/提示框
支持以下类型的警告/提示框:note tip important warning caution
NOTE这里可以添加便条信息。
TIP这里可以添加提示信息。
IMPORTANT这里可以添加重要信息。
WARNING这里可以添加警告信息。
CAUTION这里可以添加提醒信息。
基本语法
:::note这里填写内容。:::自定义标题
警告/提示框的标题可以自定义。
自定义标题这是一个带有自定义标题的 note。
:::note[自定义标题]这是一个带有自定义标题的 note。:::GitHub 语法
TIP这里同样支持 GitHub 语法。
> [!NOTE]> 这里支持 GitHub 语法。
> [!TIP]> 这里同样支持 GitHub 语法。隐藏内容
这里可以向文本中添加隐藏内容。该文本也同样支持 Markdown 语法。
你能看到后面一句吗,
Markdown
你能看到后面一句吗,:spoiler[被隐藏了 **114514**]!Mermaid 绘图示例
要使用 Mermaid,只需在代码块中指定 mermaid 语言,Mermaid 会自动将这些描述转换为精美的可视化图表。
流程图示例
graph TD A[开始] --> B{条件检查} B -->|是| C[处理步骤 1] B -->|否| D[处理步骤 2] C --> E[子流程] D --> E subgraph E [子流程详情] E1[子步骤 1] --> E2[子步骤 2] E2 --> E3[子步骤 3] end E --> F{另一个决策} F -->|选项 1| G[结果 1] F -->|选项 2| H[结果 2] F -->|选项 3| I[结果 3] G --> J[结束] H --> J I --> J时序图示例
时序图显示了对象之间随时间变化的交互。
sequenceDiagram participant 用户 participant Web应用 participant 服务器 participant 数据库
用户->>Web应用: 提交登录请求 Web应用->>服务器: 发送认证请求 服务器->>数据库: 查询用户凭证 数据库-->>服务器: 返回用户数据 服务器-->>Web应用: 返回认证结果
alt 认证成功 Web应用->>用户: 显示欢迎页面 Web应用->>服务器: 请求用户数据 服务器->>数据库: 获取用户偏好设置 数据库-->>服务器: 返回偏好设置 服务器-->>Web应用: 返回用户数据 Web应用->>用户: 加载个性化界面 else 认证失败 Web应用->>用户: 显示错误信息 Web应用->>用户: 提示重新输入 end甘特图示例
甘特图非常适合显示项目日程和时间线。
gantt title 网站开发项目时间表 dateFormat YYYY-MM-DD axisFormat %m/%d
section 设计阶段 需求分析 :a1, 2023-10-01, 7d UI 设计 :a2, after a1, 10d 原型创建 :a3, after a2, 5d
section 开发阶段 前端开发 :b1, 2023-10-20, 15d 后端开发 :b2, after a2, 18d 数据库设计 :b3, after a1, 12d
section 测试阶段 单元测试 :c1, after b1, 8d 集成测试 :c2, after b2, 10d 用户验收测试 :c3, after c2, 7d
section 部署阶段 生产环境部署 :d1, after c3, 3d 正式上线 :milestone, after d1, 0d类图示例
类图显示了系统的静态结构,包括类、属性、方法以及它们之间的关系。
classDiagram class 用户 { +String 用户名 +String 密码 +String 邮箱 +Boolean 是否激活 +登录() +登出() +更新个人资料() }
class 文章 { +String 标题 +String 内容 +Date 发布日期 +Boolean 是否发布 +发布() +编辑() +删除() }
class 评论 { +String 内容 +Date 评论日期 +添加评论() +删除评论() }
class 分类 { +String 名称 +String 描述 +添加文章() +移除文章() }
用户 "1" -- "*" 文章 : 撰写 用户 "1" -- "*" 评论 : 发表 文章 "1" -- "*" 评论 : 包含 文章 "*" -- "1" 分类 : 属于状态图示例
状态图显示了对象在其生命周期中所经历的状态序列。
stateDiagram-v2 [*] --> 草稿
草稿 --> 审核中 : 提交 审核中 --> 草稿 : 拒绝 审核中 --> 已批准 : 批准 已批准 --> 已发布 : 发布 已发布 --> 已归档 : 归档 已发布 --> 草稿 : 撤回
state 已发布 { [*] --> 可见 可见 --> 隐藏 : 暂时隐藏 隐藏 --> 可见 : 恢复 可见 --> [*] 隐藏 --> [*] }
已归档 --> [*]饼图示例
饼图是显示比例和百分比数据的理想选择。
pie title 网站流量来源分析 "搜索引擎" : 45.6 "直接访问" : 30.1 "社交媒体" : 15.3 "引荐链接" : 6.4 "其他来源" : 2.6嵌入视频
<iframe>(Inline Frame,内联框架)是 HTML 中用于在一个网页中嵌入另一个网页的元素。视频平台正是通过这个标签来嵌入他们的播放器。
示例代码结构概览
以下是嵌入代码的基本结构:
<iframe width="宽度设置" height="高度设置" src="视频播放器链接" title="框架标题" frameborder="边框设置" allow="权限设置" allowfullscreen></iframe>YouTube 嵌入代码解释
下面是一段典型的 YouTube 嵌入代码及其属性解释:
<iframe width="100%" height="468" src="https://www.youtube.com/embed/C-CYwNz3z8w" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>| 属性 | 含义 |
|---|---|
width="100%" | 播放器宽度占网页容器的 100%,通常用于响应式布局。 |
height="468" | 播放器的高度固定为 468 像素。 |
src="..." | 嵌入内容的 URL。它是 YouTube 视频播放器的服务链接。 |
title="..." | 框架的标题,用于 SEO 和可访问性。 |
frameborder="0" | 设置框架边框为 0,即无边框。 |
allow="..." | 权限设置,允许播放器使用浏览器的一些功能,如自动播放(autoplay)、全屏(picture-in-picture)等。 |
allowfullscreen | 允许用户将视频切换到全屏模式。 |
Bilibili 嵌入代码解释
Bilibili 的嵌入代码格式略有不同,但原理相似:
<iframe width="100%" height="468" src="//player.bilibili.com/player.html?bvid=BV1JThqzwEGq&p=1&autoplay=0" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" &autoplay=0></iframe>| 属性 | 含义 |
|---|---|
src="..." | 播放器链接,bvid 后跟着的是视频 ID,&autoplay=0 表示不自动播放。 |
scrolling="no" | 禁用框架的滚动条。 |
border="0", frameborder="no", framespacing="0" | 兼容性设置,用于确保无边框显示。 |
allowfullscreen="true" | 允许全屏播放。 |
部分信息可能已经过时