Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
eallion committed Feb 28, 2023
1 parent a0b5422 commit 53a56c9
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 14 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
<p align="center">
<img src="https://img.shields.io/badge/Memos-Top-orange" />
<img src="https://img.shields.io/badge/Author-eallion-brightgreen" />
<a href="https://github.com/eallion/memos.top/releases" target="_blank"><img alt="GitHub all releases" src="https://img.shields.io/github/downloads/eallion/memos.top/total"></a>
</p>

<p align="center">
Expand Down Expand Up @@ -34,7 +33,7 @@ English | [中文](./README_cn.md)

### Usage

1. Download from [Release](https://github.com/eallion/memos.top/releases), or clone this repo to self-hosted.
1. Clone this repo or Download [Release](https://github.com/eallion/memos.top/archive/refs/heads/main.zip) to self-hosted.

```bash
git clone https://github.com/eallion/memos.top
Expand Down Expand Up @@ -93,51 +92,56 @@ Upload file `index.html` and folder `assets` to your web server. Enjoy!
How to post your memos:

1. Bilibili. Just URL. `BV/AV` support. `b23.tv` not support.

```
https://www.bilibili.com/video/BV1Sd4y1b7yg/
```

2. Youtube. Just URL.

```
https://www.youtube.com/watch?v=mNK6h1dfy2o
```

3. Youku. Just URL.

```
https://v.youku.com/v_show/id_XNTkyMjkxNTEyOA==.html
```

4. QQ Video. Just URL.

```
https://v.qq.com/x/cover/mzc00200z47sdeu/m0044zpag6c.html
```

5. Spotify. Share URL. `track/album` support.

```
https://open.spotify.com/track/6Uq8BnOxvXJsQiJ2XqfO5P
```

6. Netease music. Just URL.

```
https://music.163.com/#/song?id=4153490
```

7. QQ music. Support `sondmid` only, not `songid`.

```
https://y.qq.com/n/ryqq/songDetail/004W3BfK46dMXk
```

8. Douban. Just URL. Need your own API.

> If enable. You need to uncomment [`// fetchDB()`](https://github.com/eallion/memos.top/blob/main/assets/js/main.js#L201) and replace api [`var dbAPI = "https://api.example.com/"`](https://github.com/eallion/memos.top/blob/main/assets/js/main.js#L201) in [`assets/js/main.js`](https://github.com/eallion/memos.top/blob/main/assets/js/main.js)
```
https://book.douban.com/subject/2567698/
https://movie.douban.com/subject/1889243/
```

### Update

Memos Top won't update unless the Memos API update.
So, you need to update or fix yourself.

### [LICENSE](https://github.com/me-shaon/GLWTPL)

```
Expand Down
19 changes: 12 additions & 7 deletions README_cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
<p align="center">
<img src="https://img.shields.io/badge/Memos-Top-orange" />
<img src="https://img.shields.io/badge/Author-eallion-brightgreen" />
<a href="https://github.com/eallion/memos.top/releases" target="_blank"><img alt="GitHub all releases" src="https://img.shields.io/github/downloads/eallion/memos.top/total"></a>
</p>

<p align="center">
Expand All @@ -26,15 +25,15 @@
> • 移动端自适应
- [**Memos**](https://github.com/usememos/memos)
- [Highlight.js](https://github.com/highlightjs/highlight.js)
- [Highlight.js](https://github.com/highlightjs/highlight.js)
- [Markedjs](https://github.com/markedjs/marked)
- [Moment](https://github.com/moment/moment)
- [Vanilla-lazyload](https://github.com/verlok/vanilla-lazyload)
- [ViewImage.js](https://github.com/Tokinx/ViewImage)

### 使用方法

1. [Release](https://github.com/eallion/memos.top/releases) 页面下载,或者`clone`本仓库
1. `clone`本仓库或[下载](https://github.com/eallion/memos.top/archive/refs/heads/main.zip)后部署

```bash
git clone https://github.com/eallion/memos.top
Expand Down Expand Up @@ -93,50 +92,56 @@ git clone https://github.com/eallion/memos.top
发布 Memos 时的格式:

1. Bilibili 视频。分享的视频链接。支持`BV/AV`号。暂不支持`b23.tv`链接。

```
https://www.bilibili.com/video/BV1Sd4y1b7yg/
```

2. Youtube 视频。分享的视频链接。

```
https://www.youtube.com/watch?v=mNK6h1dfy2o
```

3. Youku 视频。分享的视频链接。

```
https://v.youku.com/v_show/id_XNTkyMjkxNTEyOA==.html
```

4. 腾讯视频。分享的视频链接。

```
https://v.qq.com/x/cover/mzc00200z47sdeu/m0044zpag6c.html
```

5. Spotify 音乐。分享的链接。支持`track/album`

```
https://open.spotify.com/track/6Uq8BnOxvXJsQiJ2XqfO5P
```

6. 网易云音乐。链接即可。

```
https://music.163.com/#/song?id=4153490
```

7. QQ 音乐。只支持 `sondmid` 不支持 `songid`

```
https://y.qq.com/n/ryqq/songDetail/004W3BfK46dMXk
```

8. 豆瓣。链接即可。需要自己的 API。

> 如果要启动解析豆瓣功能,需要取消注释 [`// fetchDB()`](https://github.com/eallion/memos.top/blob/main/assets/js/main.js#L201) 然后替换成可用的 API [`var dbAPI = "https://api.example.com/"`](https://github.com/eallion/memos.top/blob/main/assets/js/main.js#L201),这两行位于: [`assets/js/main.js`](https://github.com/eallion/memos.top/blob/main/assets/js/main.js)
```
https://book.douban.com/subject/2567698/
https://movie.douban.com/subject/1889243/
```

### 关于更新

一般情况下不会更新,除非上游 Memos 有大的改动。一些简单的 Bug 自己调整一下就可以了。

### [许可证](https://github.com/me-shaon/GLWTPL)

```
Expand Down

0 comments on commit 53a56c9

Please sign in to comment.