利用 github 搭建私有笔记网站

查看 23|回复 0
作者:xiaoxuan6   
之前看 v 友询问有什么笔记平台,好多平台都需要注册登录,每次写笔记时都需要登录比较麻烦,有的平台可能会泄露一些信息。
(本人喜欢逛 github 并且支持创建私有库,突发灵感开发了该网站)
注:这里仅展示 web 网站代码,私有库暂时没开放(如果有感兴趣的后续会开放),私有库可当做数据库,支持命令行添加数据,如:
search ap "[描述](链接)"
or
search ap "测试代码{go run main.go}" // 可提交代码块( web 站暂时不展示)
github 地址:
resource-web
search

简述
将 github 私有库中的笔记,渲染到 web 网站上。

Note
私有库中的笔记文件名格式必须为:xxx.md
私有库中的笔记内容格式必须为:
  [描述 1]( https://www.baidu.com)
  [描述 2]( https://www.baidu.com)

使用方式
克隆项目
git clone https://github.com/xiaoxuan6/resource-web.git
复制 .env.example 为 .env, 修改里面的参数为自己的配置。 然后运行
go run main.go
Docker 部署
docker 直接运行
docker run --name resource \
    -e GITHUB_TOKEN="xxx" \
    -e GITHUB_OWNER="xxx" \
    -e GITHUB_REPO="xxx" \
    -p 8080:8080 \
    -d ghcr.io/xiaoxuan6/resource:latest
Docker-compose
环境要求:Git 、Docker 、Docker-Compose
克隆项目
git clone https://github.com/xiaoxuan6/resource-web.git
进入 resource-web 文件夹,运行项目
docker-compose up -d
部署成功后,通过 ip + 端口号 访问,默认端口为:8080
FAQ
为什么不使用 websocket, 而使用 axios 请求?
答:项目中调用了 api.github 频繁访问可能会导致请求失败,会被 github 拉黑
相关
cli 模式
向储存库中提交代码:search ap "[描述](链接)"
您需要登录后才可以回帖 登录 | 立即注册

返回顶部