Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/orangex4/gitnotes
一个在浏览器上运行的笔记浏览应用, 用于浏览以 Markdown 书写的, 存放在 GitLab 或 GitHub 上的笔记.
https://github.com/orangex4/gitnotes
git notes web
Last synced: about 2 months ago
JSON representation
一个在浏览器上运行的笔记浏览应用, 用于浏览以 Markdown 书写的, 存放在 GitLab 或 GitHub 上的笔记.
- Host: GitHub
- URL: https://github.com/orangex4/gitnotes
- Owner: OrangeX4
- License: mit
- Created: 2021-04-12T15:58:38.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-02-08T08:25:18.000Z (almost 3 years ago)
- Last Synced: 2024-10-04T11:58:23.893Z (3 months ago)
- Topics: git, notes, web
- Language: TypeScript
- Homepage: https://notes.orangex4.cool/
- Size: 3.63 MB
- Stars: 80
- Watchers: 2
- Forks: 13
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitNotes
这是一个由 **OrangeX4** 开发的笔记浏览应用, 用于浏览以 **Markdown** 书写的, 存放在 **GitLab 或 GitHub** 上的笔记.
优点: **数学公式支持和移动端适配**.
笔记 Git Repo 参考: [NJUAI-Notes](https://github.com/OrangeX4/NJUAI-Notes)
对应页面: [OrangeX's Notes](https://notes.orangex4.cool/?git=gitlab)
## Demo
### [OrangeX4's Notes](https://notes.orangex4.cool/)
你可以**直接使用**这个网址查看你要查看的笔记 Repo, 并不需要挂载你自己的 GitNotes.
## 界面
## 开发环境
先下载并安装 [NodeJS](https://nodejs.org/zh-cn/download/).
在终端, 你 clone 下来的目录下, 执行命令:
``` sh
npm install yarn -g
yarn install
```
等他安装完成后, 你就可以通过 `yarn start` 打开一个开发服务器或者 `yarn build` 生成静态文件了.
## 个人部署
将代码 Clone 下来, 修改 `src/App.tsx` 文件对应的内容为以下形式:
``` js
// ---------------------------------------------------
// const search = window.location.search
// 请在这里更改你需要的 url 参数
const search = '?git=github&github=typoverflow/note'
// ---------------------------------------------------
```
`search` 设为 URL 参数.
要修改标题, 可以使用搜索功能搜索字符串并修改 `public/index.html` 和 `src\App.tsx`.
更换图标, 可以更换 `public/profile.ico` 和 `public/profile.jpg` 文件.
进行完这些操作之后, 运行
``` sh
yarn start
```
便可实时浏览效果.
确认无误后, 运行
``` sh
yarn build
```
便可生成 `build` 文件夹, 将该文件夹挂载到你的域名下, 你的专属 GitNotes 笔记便挂载好了!
## 服务部署
运行命令:
``` sh
yarn build
```
并将 `build` 目录下的静态文件挂载在你的域名中.
## License
This project is licensed under the MIT License.