README.md 3.4 KB
Newer Older
X
release  
XieJiaHe 已提交
1

X
xjh22222228 已提交
2
<p align="center">
X
xjh22222228 已提交
3
  <a href="https://nav3.cn/?g">
X
xjh22222228 已提交
4 5
    <img src="src/assets/icon/logo.png" width="130" />
  </a>
X
xjh22222228 已提交
6 7 8 9 10 11 12 13 14 15 16 17 18 19
  <br />
  <b>发现导航</b>
  <p align="center">一个纯静态、易管理的强大导航网站,希望您喜欢它</p>
  <p align="center">
    <a href="https://github.com/xjh22222228/nav/stargazers"><img src="https://img.shields.io/github/stars/xjh22222228/nav" alt="Stars Badge"/></a>
    <img src="https://img.shields.io/github/license/xjh22222228/nav" />
    <a href="https://hits.dwyl.com/xjh22222228/nav">
      <img src="https://hits.dwyl.com/xjh22222228/nav.svg" />
    </a>
  </p>
</p>

<br />
<br />
X
xiejiahe 已提交
20 21


X
release  
XieJiaHe 已提交
22

X
xiejiahe 已提交
23
## 预览
X
xjh22222228 已提交
24
[在线预览](https://nav3.cn/?g)
X
release  
XieJiaHe 已提交
25 26


X
Update  
xjh22222228 已提交
27
![Preview](media/poster.png)
X
release  
XieJiaHe 已提交
28 29 30 31




X
xjh22222228 已提交
32 33
## 拥有出色的特性
- [√] 内置 `650+` 实用网站。
X
xiejiahe 已提交
34 35
- [√] 三叉树分类、结构清晰、分类清晰。
- [√] 颜值与简约并存,不再是杀马特时代。
X
xjh22222228 已提交
36
- [√] 支持3种浏览模式,创新。
X
xiejiahe 已提交
37
- [√] 支持页面定位、滚动定位。
X
xiejiahe 已提交
38 39
- [√] 支持移动端浏览。
- [√] 支持搜索查询。
X
xjh22222228 已提交
40
- [√] 纯静态, 提供自动化部署功能。
X
xjh22222228 已提交
41
- [√] 完全开源,轻松定制化。
X
release  
XieJiaHe 已提交
42

X
update  
XieJiaHe 已提交
43

X
xiejiahe 已提交
44
## 贡献
X
xjh22222228 已提交
45 46
[点击这里](https://github.com/xjh22222228/nav/tree/master/data)

X
update  
xiejiahe 已提交
47
Thank you for your [contribution](https://github.com/xjh22222228/nav/issues), men.
X
XieJiaHe 已提交
48

X
XieJiaHe 已提交
49
<a href="https://github.com/YutHelloWorld">
X
xiejiahe 已提交
50
  <img src="https://avatars1.githubusercontent.com/u/20860159?s=460&v=4" width="30px" height="30px" />
X
XieJiaHe 已提交
51
</a>
X
xiejiahe 已提交
52 53 54
<a href="https://github.com/JJJTHuang">
  <img src="https://avatars3.githubusercontent.com/u/22817432?s=460&v=4" width="30px" height="30px" />
</a>
X
xiejiahe 已提交
55 56 57
<a href="https://github.com/Fechin">
  <img src="https://avatars1.githubusercontent.com/u/2541482?s=460&v=4" width="30px" height="30px" />
</a>
X
XieJiaHe 已提交
58 59


X
XieJiaHe 已提交
60 61


X
Open  
xjh22222228 已提交
62 63
## Build Setup
``` bash
X
xjh22222228 已提交
64 65 66
# 下载
git clone --depth=1 https://github.com/xjh22222228/nav.git

67
# 安装依赖
X
Open  
xjh22222228 已提交
68 69
npm install

70
# 启动[可选]
X
Open  
xjh22222228 已提交
71 72
npm start

73
# 打包
X
Open  
xjh22222228 已提交
74 75 76 77
npm run build
```


X
xjh22222228 已提交
78
## 如何部署?
X
xjh22222228 已提交
79
我建议你使用 `github pages` 服务, 这样你就不需要提供服务器, 并且项目里自带了自动化部署服务,像数 `321` 一样简单。
X
xjh22222228 已提交
80 81 82

1、Fork 当前项目。

X
xjh22222228 已提交
83
2、[https://github.com/settings/tokens](https://github.com/settings/tokens) 申请 token。
X
xjh22222228 已提交
84

X
xjh22222228 已提交
85
3、到 https://github.com/你的名字/nav/settings/secrets/new  添加刚刚申请的token, name填写 `TOKEN`
X
xjh22222228 已提交
86 87 88

4、当推送内容到仓库后会自动部署, 打开 https://你的名字.github.io/nav  即可看到。

X
xjh22222228 已提交
89 90
5、打开 https://你的名字.github.io/nav 就能看到一个非常强大的导航网站了。

X
xjh22222228 已提交
91

X
xjh22222228 已提交
92
注:如果你想部署到自己的域名,那么以上教程同样适合,因为它提供了自动化更新, 之后你可以通过 `CNAME``反向代理` 实现。
X
xjh22222228 已提交
93

X
xjh22222228 已提交
94

X
xjh22222228 已提交
95 96 97
## 更新数据
只需要关注根目录 `data` 文件夹, 如果你使用了上面教程提供的自动化部署服务,那么当更新数据后大概5分钟即可看到。

X
xjh22222228 已提交
98 99


100 101 102 103 104
## 配置文件
`config/index.ts`, 你可以对默认的 中文 、 英文 、 Github 进行修改。


## 关于图标
X
xjh22222228 已提交
105 106 107 108 109 110 111
项目中有一部分是使用本地图标,但我建议你直接使用网络图标,方便管理。



## 建议
如果有任何功能上的建议可通过 [issue](https://github.com/xjh22222228/nav/issues) 发起, Thank you.

X
XieJiaHe 已提交
112 113


X
Open  
xjh22222228 已提交
114
## 支持开源
X
submit  
xiejiahe 已提交
115
<img src="https://raw.githubusercontent.com/xjh22222228/statics/master/images/2018/32.png" alt="支持" width="500" />
X
XieJiaHe 已提交
116

X
release  
XieJiaHe 已提交
117

X
XieJiaHe 已提交
118

X
update  
xiejiahe 已提交
119

X
release  
XieJiaHe 已提交
120

X
XieJiaHe 已提交
121
## License
X
XieJiaHe 已提交
122
[MIT](https://opensource.org/licenses/MIT)