diff --git a/README.md b/README.md index a0aba9318addb41b4e58e43cb96b41ae7694d312..847e29fffa12c72ba51695369a3359775343d644 100644 --- a/README.md +++ b/README.md @@ -1 +1,150 @@ -OK \ No newline at end of file +您当前看到的是正在公测 `v5` 版本, 稳定版本发布还需要一定时间,稳定版本请转移到 [v3](https://github.com/xjh22222228/nav/tree/v3) + +

+ + + +
+ 发现导航 +

一个纯静态、易管理的强大导航网站,希望您会喜欢

+

内置收录多达 800+ 优质网站, 助您工作、学习和生活

+

+ + Stars + Angular + + + + +

+

+ +
+
+ + +## 选择版本 +目前有2个版本供选择, [v3](https://github.com/xjh22222228/nav/tree/v3) 和 `v5`, 这2个版本都会长期维护: + +- v5 - 也就是当前分支, 需要依赖于Github配置, 提供自动维护数据功能(微后台),但必须Fork到自己仓库里。 +- v3 - 无需依赖Github, 您可以将代码部署在任意服务器, 但数据需要手工维护。 + +作者推荐您选择 `v5` 没有太多的心智负担。 + + + +## 预览 +**主题** + +- [sim 在线预览](https://nav3.cn/#/sim) +- [light 在线预览](https://nav3.cn/#/light) + +![Preview](media/screenshot1.png) +![Preview](media/screenshot2.png) + +![Preview](media/screenshot3.png) +![Preview](media/screenshot4.png) + + + + +## 拥有出色的特性 +`发现导航` 的理念就是做一款无需依赖后端服务既简单又方便,没有繁杂的配置和数据库等配置概念, 做到开箱即用。 + +- [√] 内置 `800+` 实用网站。 +- [√] 三叉树分类、结构清晰、分类清晰。 +- [√] 颜值与简约并存,不再是杀马特时代。 +- [√] 支持3种浏览模式,创新。 +- [√] 支持足迹记忆。 +- [√] 支持移动端浏览。 +- [√] 支持搜索查询。 +- [√] 支持自定义引擎搜索。 +- [√] 纯静态, 提供自动化部署功能。 +- [√] 完全开源,轻松定制化。 +- [√] 多款主题切换。 +- [√] 支持暗黑模式。 + + + +## 部署 +推荐使用 `github pages` 服务, 这样就不需要提供服务器, 并且项目里自带了自动化部署服务,像数 `321` 一样简单。 + +1、Fork 当前项目。 + +2、[https://github.com/settings/tokens](https://github.com/settings/tokens) 申请 token, 勾选相应的权限, 如果不懂就全部选中。 + +3、到 https://github.com/用户名/nav/settings/secrets/new 添加刚刚申请的token, name填写 `TOKEN` 大写。 + +4、打开 https://github.com/用户名/nav/actions 点击 `绿色按钮` + +5、往仓库推送一条Commit (非常重要)。 + +6、5分钟后打开 https://用户名.github.io/nav 就能看到一个非常强大的导航网站了。 + + +注:如果想部署到自己的域名,那么以上教程同样适合,因为它提供了自动化部署, 之后可以通过 `CNAME` 或 `反向代理` 实现: + +```conf +# nginx + +server { + listen 80; + server_name www.nav3.cn nav3.cn; + + location / { + proxy_pass https://xjh22222228.github.io/nav/; + } +} +``` + + +## 配置 +所有可配置位于文件 `nav.config.ts`。 + + + + + +## 开发构建 +``` bash +# 下载 +git clone --depth=1 https://github.com/xjh22222228/nav.git + +# 安装依赖 +npm i + +# 启动 +npm start + +# 打包 +npm run build +``` + + + +## 贡献 +[点击这里](https://github.com/xjh22222228/nav/tree/master/data) + +Thank you for your [contribution](https://github.com/xjh22222228/nav/issues), men. + + + + + + + + + + + + + +## 建议 +如果有任何功能上的建议可通过 [issue](https://github.com/xjh22222228/nav/issues) 发起, Thank you. + + + +## 支持 +如果能帮到您,可以请作者喝杯咖啡~ + + diff --git a/src/constants/index.ts b/src/constants/index.ts index fbb46633b646282c566a69108cf6f819dca583d2..ec22265f4a6020822111391b2352eec558714a94 100644 --- a/src/constants/index.ts +++ b/src/constants/index.ts @@ -1,7 +1,7 @@ // Copyright @ 2018-2021 xiejiahe. All rights reserved. MIT license. -export const VERIFY_PATH = 'README.md' +export const VERIFY_PATH = 'nav.verify.txt' -export const DB_PATH = 'nav.verify.txt' +export const DB_PATH = 'data/db.json' -export const VERSION = 'data/db.json' +export const VERSION = '5.0.0-beta.1'