Skip to content

Commit

Permalink
add document and template
Browse files Browse the repository at this point in the history
  • Loading branch information
xunpod committed Feb 21, 2024
1 parent 3c66f5c commit 526094d
Show file tree
Hide file tree
Showing 4 changed files with 133 additions and 14 deletions.
80 changes: 66 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,76 @@
# 仓库结构
## 基本

content
scripts
static
hugo.yaml
使用 [Markdown](https://en.wikipedia.org/wiki/Markdown) 来书写内容,创建列表。支持绝大多数相关语法。

# 撰写规范
### LaTex公式

## 应用信息
参考[latex-project.org](https://www.latex-project.org/)

### 额外操作
### Mermaid图表

言简意赅
参考[Mermaid | Diagramming and charting tool](https://mermaid.js.org/)

引用文档
## 文件名

引用图片
一般情况下取`应用编号.md`作为文件名。

静态资源
## 文档头(Front-matter)

其他内容
```
---
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: 应用名称` 渲染生成。

### 应用编号

- 龙芯应用合作社

跟随[龙芯应用合作社](http://app.loongapps.cn/#/home) 编号,应用编号也为该应用的文档名。

- 其他来源

按报告顺序以1开始的正整数为编号,应用编号也为该应用的文件名。

### 历史版本

历史版本以应用的历史版本号作为标题,将对应版本的文档内容挪入,结构参考![应用详情文档结构](/static/images/应用详情文档结构.png)

参考[hugo](https://gohugo.io/)以及[hextra](https://imfing.github.io/hextra/)
Binary file added static/images/应用详情文档结构.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 34 additions & 0 deletions template/其他来源-应用模板.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: 其他来源-应用模板
toc: true
weight: 1

---

## 应用信息

| 编号 | 应用来源 | 应用名称 | 页面链接 | 版本号 | 兼容性 | liblol版本 |
| ---: | -------- | :------- | :------- | :----- | :----- | :--------- |
| 1 | | | [查看] | V2 | | |

### 安装libLoL及该应用

参考[使用方法](/docs/usage)

### 额外操作

## 历史版本

### v1

#### 应用信息

| 编号 | 应用来源 | 应用名称 | 页面链接 | 版本号 | 兼容性 | liblol版本 |
| ---: | -------- | :------- | :------- | :----- | :----- | :--------- |
| 1 | | | | V1 | | |

#### 安装libLoL及该应用

参考[使用方法](/docs/usage)

#### 额外操作
33 changes: 33 additions & 0 deletions template/龙芯应用合作社-应用模板.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: 龙芯应用合作社-应用模板
toc: true
wight: 1
---

## 应用信息

| 编号 | 应用名称 | 页面链接 | 版本 | 下载链接 | 应用类型 | 开发者 | 更新时间 | 兼容性 | liblol版本 |
| ---: | :------- | :------- | :--- | :------- | :------- | :----- | :------- | :----- | :--------- |
| 1 | | [跳转] | v2 | [下载] | | | | | |

### 安装libLoL及该应用

参考[使用方法](/docs/usage)

### 额外操作

## 历史版本

### V1

#### 应用信息

| 编号 | 应用名称 | 页面链接 | 版本 | 下载链接 | 应用类型 | 开发者 | 更新时间 | 兼容性 | liblol版本 |
| ---: | :------- | :------- | :--- | :------- | :------- | :----- | :------- | :----- | :--------- |
| 1 | | [跳转] | v1 | [下载] | | | | | |

#### 安装libLoL及该应用

参考[使用方法](/docs/usage)

#### 额外操作

0 comments on commit 526094d

Please sign in to comment.