README.md 5.9 KB
Newer Older
X
xjh22222228 已提交
1 2 3 4 5 6 7

<p align="center">
  <a href="https://nav3.cn/?g">
    <img src="src/assets/logo.png" width="130" />
  </a>
  <br />
  <b>发现导航</b>
X
xjh22222228 已提交
8
  <p align="center">一个纯静态、支持SEO、在线编辑的强大导航网站,希望您会喜欢</p>
X
xjh22222228 已提交
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
  <p align="center">内置收录多达 800+ 优质网站, 助您工作、学习和生活</p>
  <p align="center">
    <img src="https://img.shields.io/github/v/release/xjh22222228/nav" />
    <a href="https://github.com/xjh22222228/nav/stargazers"><img src="https://img.shields.io/github/stars/xjh22222228/nav" alt="Stars"/></a>
    <img alt="Angular" src="https://img.shields.io/static/v1.svg?label=&message=Angular11&style=flat-square&color=C82B38">
    <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
xjh22222228 已提交
28 29
- [Sim 在线预览](https://nav3.cn/#/sim)
- [Light 在线预览](https://nav3.cn/#/light)
X
xjh22222228 已提交
30
- [Side 在线预览](https://nav3.cn/#/side)
X
xjh22222228 已提交
31
- [App 在线预览](https://nav3.cn/#/app)
X
xjh22222228 已提交
32

X
xjh22222228 已提交
33 34 35 36 37
![Preview](https://raw.githubusercontent.com/xjh22222228/public/gh-pages/nav/1.png)
![Preview](https://raw.githubusercontent.com/xjh22222228/public/gh-pages/nav/2.png)
![Preview](https://raw.githubusercontent.com/xjh22222228/public/gh-pages/nav/3.png)
![Preview](https://raw.githubusercontent.com/xjh22222228/public/gh-pages/nav/4.png)
![Preview](https://raw.githubusercontent.com/xjh22222228/public/gh-pages/nav/5.png)
X
xjh22222228 已提交
38 39 40



X
xjh22222228 已提交
41 42


X
xjh22222228 已提交
43

X
xjh22222228 已提交
44
## 特性
X
xjh22222228 已提交
45 46
`发现导航` 的理念就是做一款无需依赖后端服务既简单又方便,没有繁杂的配置和数据库等配置概念, 做到开箱即用。

X
xjh22222228 已提交
47
- 🍰 内置 `800+` 实用网站。
X
xjh22222228 已提交
48
- 🍰 支持 SEO。
X
xjh22222228 已提交
49 50
- 🍰 完全纯静态, 提供自动化部署功能。
- 🍰 三叉树分类、结构清晰、分类清晰。
X
xjh22222228 已提交
51
- 🍰 支持一个网站关联多个网址
X
xjh22222228 已提交
52
- 🍰 颜值与简约并存,不再是杀马特时代。
X
xjh22222228 已提交
53
- 🍰 完全开源,轻松定制化。
X
xjh22222228 已提交
54 55 56 57 58 59 60 61
- 🍰 支持多种浏览模式,创新。
- 🍰 支持足迹记忆。
- 🍰 支持移动端浏览。
- 🍰 支持搜索查询。
- 🍰 支持自定义引擎搜索。
- 🍰 多款主题切换。
- 🍰 支持暗黑模式。
- 🍰 支持快捷键操作,一步到位。
X
xjh22222228 已提交
62
- 🍰 支持后台管理, 无需部署。
X
xjh22222228 已提交
63
- 🍰 支持从Chrome书签导入
X
xjh22222228 已提交
64 65 66 67



## 部署
X
xjh22222228 已提交
68
像数 `321` 一样简单。
X
xjh22222228 已提交
69

X
xjh22222228 已提交
70
#### 方式一(gh-pages免费)
X
xjh22222228 已提交
71 72
1、Fork 当前项目。

X
xjh22222228 已提交
73
2、[https://github.com/settings/tokens](https://github.com/settings/tokens) 申请 token, 勾选相应的权限, 如果不懂就全部选中,复制并保存Token。
X
xjh22222228 已提交
74

X
xjh22222228 已提交
75
3、https://github.com/用户名/nav/settings/secrets/actions/new  添加申请的token, name填写 `TOKEN` 大写。
X
xjh22222228 已提交
76

X
xjh22222228 已提交
77
4、打开 https://github.com/用户名/nav/actions 点击 `绿色按钮`
X
xjh22222228 已提交
78

X
xjh22222228 已提交
79
5、务必修改项目配置文件 [nav.config.ts](nav.config.ts)
X
xjh22222228 已提交
80

X
xjh22222228 已提交
81
6、5分钟后打开 https://用户名.github.io/nav 就能看到一个非常强大的导航网站了。
X
xjh22222228 已提交
82

X
xjh22222228 已提交
83 84 85 86 87 88 89
### 推荐方式二(Vercel免费)
和方式一的步骤一样,除了第4步不用。

具体使用跟着步骤走即可 [https://github.com/apps/vercel](https://github.com/apps/vercel)



X
xjh22222228 已提交
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106

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

```conf
# nginx

server {
    listen       80;
    server_name  www.nav3.cn nav3.cn;

    location / {
        proxy_pass https://xjh22222228.github.io/nav/;
    }
}
```


X
xjh22222228 已提交
107
## 书签导入
X
xjh22222228 已提交
108
支持从 Chrome 书签导入(WebKit内核应该都是支持的~),会自动检测满足三级分类的导航,其他一律设为未分类:
X
xjh22222228 已提交
109 110 111 112 113 114

![](https://raw.githubusercontent.com/xjh22222228/public/gh-pages/nav/import.png)

浏览器打开 [chrome://bookmarks/](chrome://bookmarks/) 导出书签得到 html 文件, 接着从导航网站后台导入即可。


X
xjh22222228 已提交
115 116 117



X
xjh22222228 已提交
118 119
## 升级
在升级之前请备份根目录下的 `data` 文件夹和 `nav.config.ts`, 升级完后替换即可。
X
xjh22222228 已提交
120

X
xjh22222228 已提交
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
点击右上角 `Watch` 按钮第一时间跟踪版本升级。



## 更新日志
[CHANGELOG](CHANGELOG.md)




## 快捷键
mac下是 `Command`,windows 下是 `Ctrl`

- `ctrl+v` 查看信息
- `ctrl+d` 开启或关闭暗黑模式

如对快捷键有特殊要求请发起 [issues](https://github.com/xjh22222228/nav/issues)
X
xjh22222228 已提交
138 139 140 141




X
xjh22222228 已提交
142 143 144 145 146 147

## 开发构建
``` bash
# 下载
git clone --depth=1 https://github.com/xjh22222228/nav.git

148 149
cd nav

X
xjh22222228 已提交
150
# 安装依赖
X
xjh22222228 已提交
151
yarn
X
xjh22222228 已提交
152 153

# 启动
X
xjh22222228 已提交
154
yarn start
X
xjh22222228 已提交
155 156

# 打包
X
xjh22222228 已提交
157
yarn build
X
xjh22222228 已提交
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
```



## 贡献
[点击这里](https://github.com/xjh22222228/nav/tree/master/data)

Thank you for your [contribution](https://github.com/xjh22222228/nav/issues), men.

<a href="https://github.com/YutHelloWorld">
  <img src="https://avatars1.githubusercontent.com/u/20860159?s=460&v=4" width="30px" height="30px" />
</a>
<a href="https://github.com/JJJTHuang">
  <img src="https://avatars3.githubusercontent.com/u/22817432?s=460&v=4" width="30px" height="30px" />
</a>
<a href="https://github.com/Fechin">
  <img src="https://avatars1.githubusercontent.com/u/2541482?s=460&v=4" width="30px" height="30px" />
</a>
X
xjh22222228 已提交
176 177 178
<a href="https://github.com/setdiaoyong">
  <img src="https://avatars1.githubusercontent.com/u/62551864?s=460&v=4" width="30px" height="30px" />
</a>
X
xjh22222228 已提交
179 180 181



X
xjh22222228 已提交
182 183 184



X
xjh22222228 已提交
185 186 187 188 189 190
## 建议
如果有任何功能上的建议可通过 [issue](https://github.com/xjh22222228/nav/issues) 发起, Thank you.



## 支持
X
xjh22222228 已提交
191 192 193
项目成立于 2018 年到至今一直坚持维护和开源, 经过N次的迭代与优化, 如果项目能帮到您是我的荣幸。

您可以请作者喝杯咖啡,继续战斗下去(请备注Github名字)~
X
xjh22222228 已提交
194

X
xjh22222228 已提交
195
<img src="https://cdn.jsdelivr.net/gh/xjh22222228/public@gh-pages/img/32.png" width="600">
X
xjh22222228 已提交
196 197

感谢您的认可:
X
xjh22222228 已提交
198
| 姓名    | 支持金额              |
X
xjh22222228 已提交
199
| --------------------------------------- |----------- |
X
xjh22222228 已提交
200
| [aiyou9](https://github.com/aiyou9)     | ¥50.00     |
201
| 路人甲     | ¥50.00     |
X
xjh22222228 已提交
202