本网站文章的书写帮助（Markdown+Chirpy）
为本网站做文档贡献时的文章书写方法汇总
1.概要
这个静态网站使用了github官方支持的Jekyll工具构建，采用了Chirpy theme for Jekyll主题，文档语法使用Markdown+Chirpy提供的扩展书写。 想参与文档共创的话，可以在通过在github上提交pull request的方式参与进来。
同时，这篇文章大部分仅显示了实现效果，具体语法请在github上参看raw文件。
2.Github仓的相关信息
文章管理位置 - 文件夹：_posts\[年]\[年-月-日]_[你的文章名].md
例: 本文的命名方法：
_posts\2024\2024-08-08-help-markdown.md
图片的管理位置 - 文件夹：/assets/img/in-post/[年]/[年-月-日]/
例: 本文的图片管理位置：
/assets/img/in-post/2024/2024-08-08/
3.文档语法
眉批(Front Matter)
下述样例内容是眉批的所有（笔者目前掌握的）相关属性定义，实际书写时，仅定义title、date、categories、tags、descriptiony亦可。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
---
title: 社区文章的书写帮助（Markdown+Chirpy）
date: 2024-08-08 +0800
categories: [社区管理, 帮助] #上级文文档，下级文档
tags: [社区管理] # TAG names should always be lowercase，可以有无数个标签
description: . # 描述
toc: false #
author: # 作者信息
name: Full Name
link: https://example.com
toc: false # 关闭目录
comments: false # 关闭评论
math: true # 加载数学功能
mermaid: true # 启用Mermaid
pin: true # 置顶帖子
media_subpath : /assets/img/in-post/2024/2024-08-08/
image:
path: idempiere11_img_back.jpg
---
1
2
不希望显示行号时，在代码块后面另起一行添加下述内容
{: .nolineno }
文章
文章基本书写方式请在网上查找markdown格式文档的制作说明。 后续就一些可以丰富markdown表现形式的书写方式进行说明。
图片
1
2
3
4
{:.shadow width="250"}
_图片说明下标1_
{: width="500" height="250" }
_图片说明下标2_
图片说明下标1 图片说明下标2
提示
提示 - {: .prompt-tip }
信息 - {: .prompt-info }
警告 - {: .prompt-warning }
危险 - {: .prompt-danger }
提示（仅本网站可用）
内容描述1.
内容描述2.
内容描述3.
内容描述4.
内容描述5.
\[x^2 + y^2 =z^2\]
提示 - {: .box-tip }
信息 - {: .box-info }
警告 - {: .box-warning }
危险 - {: .box-danger }
Task List
- task 1
- task 2
代码块
1
2
3
4
int main()
{
return 0;
}
内联代码
hello，world!
表格
| 左对齐 | 右对齐 | 居中对齐 |
|---|---|---|
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |
数学公式
需要在头信息中添加以下信息
math: true # 加载数学功能
内联公式 $x+y$
公式块 \(\begin{Bmatrix} a & b \\ c & d \end{Bmatrix}\) \(\begin{CD} A @>a>> B \\ @VbVV @AAcA \\ C @= D \end{CD}\)
HTML元素定义
使用 Ctrl+Alt+Del 重启电脑
折叠展现
折叠状态
展开后显示的信息
\[x^2 + y^2 =z^2, \quad x_{1,2} = \frac{-b\pm\sqrt{b^2-4ac}}{2a}\]