# 开源百科

这是开源百科[首页](https://docs.gitcode.net)的维护仓库，作为建设的各种开源框架、编程语言的聚合页，提高`SEO`权重所打造。

## 开发

#### Git Clone
```
git@gitcode.net:dev-cloud/oss-pedia.git
cd oss-pedia
npm install
npm start
code ./
```

#### 内容添加
虽然这是基于[`Hexo`](https://hexo.io/)框架静态站点，但是目前使用简单，只更新`source/index.html`文件，后续有新的需求在增加。


#### 本地实时预览
```
http://localhost:4000
```

#### Build 编译
```
npm run build
```

#### 提交更新
内容比较少，暂时不使用`MR`方式，采用直接 `git commit`与`git push`即可。

## 部署
在[`GitCode 仓库 Pages`](https://gitcode.net/dev-cloud/oss-pedia/-/services/pages/edit)中设置"`启用集成`"。
- `Page template`是`HTML`
- `Branches to be created` 是 `master`
- `Path`是`public`

## 访问

#### Pages 地址
[https://dev-cloud.gitcode.host/oss-pedia/](https://dev-cloud.gitcode.host/oss-pedia/)

#### 线上地址
[http://docs.gitcode.net](http://docs.gitcode.net)

## 关于`SEO`

如果新增加`URL子目录`，需要执行如下操作；

- 在`./sitemap-merge.js`中添加该子目录的`sitemap.xml`完整路径；eg.`https://docs.gitcode.net/spring/guide/sitemap.xml`
- 在执行`npm run build` 时会自动的追加到`public/robots.txt`与`public/sitemap.xml`中

---
> 感谢模版 [http://carlos-algms.github.io/](http://carlos-algms.github.io/)