Skip to content

Latest commit

 

History

History
196 lines (134 loc) · 5.36 KB

README_en.md

File metadata and controls

196 lines (134 loc) · 5.36 KB
Raw

✍️ memos

Memos Top. A static page rendered with the Memos API.

Simple HTML, Pure CSS, Vanilla JS.

Live Demo • I'm Feeling Lucky ✍

Memos Top

English | 中文

Tip

Support legacy API (< v0.22.0) and new API ( >= v0.22.0 ), Please set APIVersion

Note

If you're looking to embed your Mastodon toots on your website, you might want to check out this project.
https://github.com/eallion/mastodon-embed-timeline

WebStack

• Darkmode Support
• Mobile Friendly

Usage

1. Clone this repo or Download Release to self-hosted
git clone https://github.com/eallion/memos.top
2. Setting

Replace the default value in index.html:

<script type="text/javascript">
  var memos = {
    host: 'https://demo.usememos.com/',  // Your Memos, with '/' end.
    limit: '10',  // Pagination to show.
    creatorId: '1',  // The old instance is 101, and the new instance is 1.
    domId: '#memos',  // Default #memos.
    username: 'memos',  // You can customize the display ID that is not related to memos.
    name: 'Official Demo',  // You can customize the displayed full name, that is not related to memos.
    language: 'en', // `en` `zh-CN` etc. Used by Relative Time.
    APIVersion: 'new', // `new` or `legacy`, Memos API Version, <`v0.22.0`: `legacy`, >=`v0.22.0`: `new`.
    total: true, // Display total memos. No interface is displayed in the new version.
    doubanAPI: '', // Fill a API to render douban subject. `null` to disable. API self-hosted: https://github.com/eallion/douban-api-rs
  }
</script>
3. Logo & Avatar(Option)

Replace the Logo and Avatar in the assets/img folder.

4. Upload

Upload file index.html and folder assets to your web server. Enjoy!

Hosted by GitHub Pages

Demo: https://eallion.github.io/memos.top

  1. Fork this
  2. Setting as #Usage.2
  3. Go to your own memos.top repo - Setting - Pages - Deploy from a branch - Branch(main/root)

Hosted by Vercel

Demo: https://memos-demo.vercel.app/

  1. Fork this
  2. Setting as #Usage.2
  3. Go to your Vercel dash
  4. Import GitHub repo
  5. Configure Project default
  6. Deploy

Todo:

  • One key deployment

Other

Yes! You can deploy to Cloudflare Pages or Netlify and so on.

Tips

How to post your memos: 👈👈👈
  1. Bilibili. Just URL. BV/AV support. b23.tv not support.
https://www.bilibili.com/video/BV1Sd4y1b7yg/
  1. Youtube. Just URL.
https://www.youtube.com/watch?v=mNK6h1dfy2o
  1. Youku. Just URL.
https://v.youku.com/v_show/id_XNTkyMjkxNTEyOA==.html
  1. QQ Video. Just URL.
https://v.qq.com/x/cover/mzc00200z47sdeu/m0044zpag6c.html
  1. Spotify. Share URL. track/album support.
https://open.spotify.com/track/6Uq8BnOxvXJsQiJ2XqfO5P
  1. Netease music. Just URL.
https://music.163.com/#/song?id=4153490
  1. QQ music. Support sondmid only, not songid.
https://y.qq.com/n/ryqq/songDetail/004W3BfK46dMXk
  1. Douban. Just URL. Need your own API.

If enable. You need to self hosted an API: https://github.com/eallion/douban-api-rs

https://book.douban.com/subject/2567698/
https://movie.douban.com/subject/1889243/

LICENSE GLWTPL

               GLWT(Good Luck With That) Public License
                 Copyright (c) Everyone, except Author

Everyone is permitted to copy, distribute, modify, merge, sell, publish,
sublicense or whatever they want with this software but at their OWN RISK.

                            Preamble

The author has absolutely no clue what the code in this project does.
It might just work or not, there is no third option.


                GOOD LUCK WITH THAT PUBLIC LICENSE
   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION, AND MODIFICATION

  0. You just DO WHATEVER YOU WANT TO as long as you NEVER LEAVE A
TRACE TO TRACK THE AUTHOR of the original product to blame for or hold
responsible.

IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

Good luck and Godspeed.