使用 Markdown 来书写内容,创建列表。支持绝大多数相关语法。
参考Mermaid | Diagramming and charting tool 。
一般情况下取应用编号.md
作为文件名。
---
title: 应用名称 //也作为文档的一级标题
toc: true/false //侧边栏开启/关闭,一般情况下为true。
weight: 应用编号 //文档的排列顺序。一般情况下,取应用编号的值。
draft: true/false //当值为true时文档作为草稿,不渲染。
---
文档中的静态内容存放于仓库目录/static
中。一般情况下,将/static
视为根目录,并以绝对路径方式引用。
- 引用图片
/static/images
中的logo.svg
:
![](/images/logo.svg)
- 引用文件
/static/data
中的loongapplist-latest.csv
:
[loongapplist-latest.csv](/data/loongapplist-latest.csv)
一般情况下,将仓库目录/content
视为根目录,以绝对路径方式引用,但无需添加文件扩展名。
- 引用
/content/docs/dev/liblol.md
[libLoL](/docs/dev/liblol)
内容的最高级标题应为H2,H1为文档头的title: 应用名称
渲染生成。
- 龙芯应用合作社
跟随龙芯应用合作社 编号,应用编号也为该应用的文档名。
- 其他来源
按报告顺序以1开始的正整数为编号,应用编号也为该应用的文件名。
历史版本以应用的历史版本号作为标题,将对应版本的文档内容挪入。
结构参考/template