提交 38a67c79 编写于 作者: Lab机器人's avatar Lab机器人

<docs>(add):添加文档更新基础说明

上级 8e6ad3e0
## 项目说明
本项目用于维护和构建中国开源软件推进联盟的站点内容,站点地址为 <https://copu.gitcode.host/copu/>
### 项目结构
项目结构如下:
```bash
├── LICENSE
├── README.md
├── archetypes
│ └── default.md
├── config.toml
├── content
│ ├── 2022
│ ├── 2023
│ ├── 开源发展蓝皮书
│ ├── 深度信息技术专辑
│ └── 评人工智能如何走向新阶段
├── static
│ └── images
└── themes
├── dot
└── hugo-theme-pdf-js
```
#### 站点设置
站点相关设置更新 `config.toml` 文件
#### 站点内容
站点内容更新 `content` 目录下内容,每新增一个内容需要对应增加一个 `xx.md` 文件,其中该文件内容格式为:
```markdown
---
title: "第一集"
date: 2020-12-14
lastmod: 2020-12-14
weight: 1
draft: false
# search related keywords
# keywords: ["北京","360"]
---
{{< embed-pdf-view url="/images/第一集.pdf" >}}
```
其中:
- `title` : 新增内容的标题
- `date` : 新增内容在网页上显示的创建日期
- `lastmod` : 新增内容在网页上显示的更新日期
- `weight` : 新增内容在当前栏目下的排序
正文内容使用 `{{< embed-pdf-view url="/images/第一集.pdf" >}}` ,该内容会在网页上自动渲染 `static/iamges` 目录下对应的 PDF 文件,因此需要将对应的 PDF 文件添加到 `static/iamges` 目录下, PDF 文件尽量用英文命令、且文件名中不要含空格等特殊字符
### 更新站点
在熟悉以上内容结构后,就可以开始通过 git 命令来完成 站点内容的更新操作:
1. git clone 项目到本地
`git clone git@gitcode.net:COPU/copu.git`
2. 进入目录并开始更新内容
`cd copu`
3. 添加更新好的内容
`git add .`
`git commit -m '<docs>(add):添加内容说明'`
4. git push 更新内容到 GitCode
`git push origin master`
5. 等待 GitCode 自动运行流水线并使用新的内容构建站点,构建过程可以在 https://gitcode.net/COPU/copu/-/pipelines 中查看
注: 以上操作需要在本地终端进行操作,需要有一定 git 知识,且需要绑定 ssh key,相关操作可以见 https://gitcode.net/-/profile/keys 页面
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册