Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hueliu/nav
个人网址导航
https://github.com/hueliu/nav
docker lua nav nginx notion openresty website
Last synced: 2 days ago
JSON representation
个人网址导航
- Host: GitHub
- URL: https://github.com/hueliu/nav
- Owner: HueLiu
- Created: 2024-07-23T03:31:44.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-08-16T08:52:40.000Z (5 months ago)
- Last Synced: 2025-01-19T17:55:48.136Z (2 days ago)
- Topics: docker, lua, nav, nginx, notion, openresty, website
- Language: Lua
- Homepage:
- Size: 146 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 一个基于 [Notion](https://www.notion.so) + [OpenResty](https://openresty.org) 的伪静态响应式网址导航主题
## 使用说明
这是一个完全开源的项目，你可以直接拿来制作自己的网址导航，如果你对本主题进行了一些个性化调整，欢迎来本项目中 [issue](https://github.com/HueLiu/nav/issues) 分享一下！
- 复制 [Notion 模板](https://ambitious-iodine-152.notion.site/5161a09e2e5b421590a4278155ba4e44?v=a16988cd530d4a819493556ecc6c5f62&pvs=4) 并获取你的 Notion 模板 ID
- 创建 [Notion API token](https://www.notion.so/profile/integrations)
- 将你的 Notion 模板连接到该 token
- 安装 [OpenResty](https://openresty.org) 到本地或服务器
- 设置环境变量
```.env
SITE_TYPE=notion
NOTION_DATABASE=你的 Notion 模板 ID
NOTION_TOKEN=你的 Notion API Token
```
- 克隆本项目到本地或服务器，在项目根目录下执行命令（你也可以调整 nginx 配置文件）:
```shell
启动：openresty -p `pwd`/ -c conf/nginx.conf
停止：openresty -p `pwd`/ -c conf/nginx.conf -s stop # 立即关闭整个服务
退出 -p `pwd`/ -c conf/nginx.conf -s quit # “优雅” 的关闭整个服务，worker 进程处理完当前用户请求再关闭
重启：openresty -p `pwd`/ -c conf/nginx.conf -s reload # 重读配置文件并使用服务对新配置项生效，只针对配置文件
```
- Docker 安装 (推荐)
```shell
docker pull harleyliu/nav
docker run -d -p 8080:8080 \
-e=SITE_TYPE=notion \
-e=NOTION_TOKEN=your_notion_token \
-e=NOTION_DATABASE=your_notion_template_id \
harleyliu/nav:latest
```
## 计划
- [x] docker
- [ ] 集成 AriaTable
- [ ] 集成 NocoDB
## 感谢
本项目的部分代码参考了以下开源项目，特此感谢。
- [shenweiyan/WebStack-Hugo](https://github.com/shenweiyan/WebStack-Hugo)