泛动引擎 > 关于我们 > 如何完善文档

如何完善文档

1、安装Hugo

你需要下一个较新的extended版本 (推荐0.53以上) 的 Hugo。确保下载的是extended版的hugo,千万不要下载relese版的Hugo,因为它不支持 SCSS.

有关全面的 Hugo开发文档，请参阅 gohugo.io。

查看是否已经安装hugo ,或查看hugo安装的版本，请运行以下命令：

hugo version

2、不同平台的安装

windows平台

（1）下载 hugo extended 版

点击 hugo下载下载。记得下载extended 版。例如，64位的windows系统可以下载hugo_extended_0.75.1_Windows-64bit.zip.

（2）配置环境变量

将hugo.exe加入windows系统环境变量，记得路径中不要有空格，否则出现一些奇奇怪怪的错误。例如，路径D:\Hugo\bin是正确的。D:\Program Files (x86)\Hugo\bin就不正确。
Linux平台不要使用 sudo apt-get install hugo来安装hugo, 因为这样不会安装hugo extended 版。

如果您已经安装了hugo，可以通过以下指令查看您安装的版本:
```
hugo version
```
如果您安装的是 v0.52 或更早的版本。那您需要更新hugo：
1. 下载Hugo
2. 找到Hugo extended版
3. 下载(例如：hugo_extended_0.5X_Linux-64bit.tar.gz).
4. 创建一个文件夹:
```
mkdir hugo
```
5. 加压下载的hugo压缩包。
6. 进入该文件夹:
```
cd hugo
```
7. 安装hugo:
```
sudo install hugo /usr/bin    
```
macOS平台

使用 Brew安装hugo。

3、安装 Node.js 和 npm

如果您已经安装了Node.js和npm, 通过以下指令可以查看当前的版本：

node -v
npm -v

点击下载 Node.js并安装。

4、安装 PostCSS

安装了最新Node.js后，通过命令行可以安装 PostCSS:

npm install postcss --save-dev
npm install -D --save autoprefixer
npm install -D --save postcss-cli

5、克隆 Peridyno-docs 网站代码

使用git 克隆网站源码:

git clone https://github.com/peridyno/peri-docs.git

进入文件夹:
```
cd peri-docs
```
运行完整:
```
hugo server
```

在浏览器中输入 http://localhost:1313/ 就能访问peridyno本地网站。通过 Ctrl + c 来关闭。

在windows的cmd中，进入当前文件夹，输入hugo server启动本地服务器。

6、Pull requests指令

最后，您可以在我们的 github 存储库中发出“Pull requests”指令。感谢您对 Peridyno 开源项目的贡献！

7、发布Peridyno网站

生成public文件夹
```
  cd peridyno-doc
  hugo
```

推送项目文件（如果有权限的话）

  cd public 
  git init
  git add -A
  git commit -am "init"
  git remote add origin https://github.com/peridyno/peri-docs.github.io
  git push -f origin master

修改域名（如果有权限的话）

  在 peridynoTeam.github.io 项目设置（https://github.com/peridyno/peri-docs.github.io/settings）中自定义域中添加“www.peridyno.com”。
  等待几分钟，您可以在 `www.peridyno.com` 上看到 Peridyno 网站。

如果您觉得我们这个项目有意义，那就加入我们吧!!!