文档
如何帮助编写和完善小熊猫C++的官方网站和文档
小熊猫C++网站简介
小熊猫C++网站使用Markdown语言来撰写内容,使用hugo工具来对内容排版并生成静态网页。
hugo使用主题来对内容进行排版。由于hugo不支持同时使用多个主题,为了达到更好的视觉效果,作者将小熊猫C++网站分成了两个部分,每个部分由一个hugo网站组成,分别使用不同的主题:
- 首页和日志,位于sources/main子文件夹中,使用hugo-universal-theme主题生成最终网页
- 文档,位于sources/docs子文件夹中,使用docsy主题生成最终网页
下载和安装相关工具
hugo
在hugo网站上可以下载最新版的hugo-exteneded程序。下载后可以把解压的hugo.exe所在文件夹加入到系统的PATH环境变量中,以方便使用。
node.js
docsy主题需要使用node.js来辅助生成一些需要的内容,因此还需要安装node.js。直接从官网下载安装即可。
获取小熊猫C++网站源码
请按下列步骤获取小熊猫C++的网站源码:
- 登录gitee网站。(如果没有账号请注册一个)
- 打开小熊猫C++网站项目仓库,点击网页右上方的fork按钮,fork一个仓库到自己的账号中。
- 打开fork得到的位于自己账号下的仓库,点击网页的克隆/下载,复制仓库的网址。
- 使用git或者支持git的其他工具将仓库clone到本机文件夹中。
- 进入sources/docs文件夹,在控制台或者shell下执行下列指令:
npm install -D autoprefixer
npm install -D postcss-cli
npm install -D postcss
说明:由于国内访问npm官方仓库速度较慢,建议用户预先将npm的仓库设为taobao等国内镜像。
在本地查看修改效果
网站首页和日志
进入sources/main文件夹,执行:
hugo server
成功执行后,按照hugo运行后的提示信息,在浏览器中打开对应的本地网址,即可查看网站首页和日志排版后的效果
文档
进入sources/docs文件夹,执行:
hugo server
成功执行后,按照hugo运行后的提示信息,在浏览器中打开对应的本地网址,即可查看文档排版后的效果。
提交修改后的网站源码
完成内容的修改后,提交(commit)修改,并将其推送(push)到gitee仓库中。
然后在gitee仓库的网页中找到**"+Pull Request"**按钮,进行提交即可。
最后修改 March 18, 2022: update (ce7d9ea1)