投稿教程
我们期待任何有兴趣、有能力的安全人员和我们一起补充这个知识库!
如何向这个知识库投稿可以查看下面教程!
1. 投稿文件的格式
准备好markdown格式
的文章,假如文章中存在图片,则把图片单独放到一个文件夹,
图片文件夹
命名和文章名
一样
文章名
尽量和文章中的标题(title)一样
2. 投稿文章的要求
- 元数据(Metadata)
每篇markdown
文章至少在文章首部需要有
title: xxx # 文章名
description: xxx # 文章内容描述
- 标题(markdown heading)
支持三种级别标题
## Level 2 title
### Level 3 title
#### Level 4 title
两级和三级标题可以在侧边栏显示,四级标题不显示。
- 图片在文章中的路径为绝对路径
例:
- 内容全面
知识库文章要求能包含此文章主题的相关原理、利用、扩展、参考资料。
内容详实、全面。
3. 知识库支持的一些markdown语法
- Admonitions
Example:
:::note
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
:::
:::tip
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
:::
:::info
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
:::
:::caution
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
:::
:::danger
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
:::
note
Some content with markdown syntax
. Check this api
.
tip
Some content with markdown syntax
. Check this api
.
info
Some content with markdown syntax
. Check this api
.
caution
Some content with markdown syntax
. Check this api
.
danger
Some content with markdown syntax
. Check this api
.