From c0d424a8d0f01ae74d97364567ec855a3e86dc3c Mon Sep 17 00:00:00 2001
From: Cell <1024@lruihao.cn>
Date: Thu, 24 Oct 2024 10:29:27 +0800
Subject: [PATCH] =?UTF-8?q?Feat:=20=E4=BF=AE=E6=94=B9=E5=8C=85=E5=90=8D?=
=?UTF-8?q?=E4=B8=BA=20github.com/hugo-fixit/shortcode-mmt-netease?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
原包 github.com/Lruihao/hugo-shortcode-mmt-netease 保留在 legacy 分支
---
README.md | 59 ++++++++++++++++++++++-------
go.mod | 2 +-
layouts/shortcodes/mmt-netease.html | 2 +-
theme.toml | 21 ++++++++++
4 files changed, 68 insertions(+), 16 deletions(-)
create mode 100644 theme.toml
diff --git a/README.md b/README.md
index 44025e0..f5316f8 100644
--- a/README.md
+++ b/README.md
@@ -1,34 +1,64 @@
-# hugo-shortcode-mmt-netease
+# shortcode-mmt-netease
![preview](https://user-images.githubusercontent.com/33419593/221810055-bf78de27-8f5d-4ffa-bf02-f60c0939f169.png)
一个含有网易云随机评论 shortcode 的 Hugo 主题组件。
-## Installation
+## Demo
-将此 git 存储库克隆到您的主题文件夹中并添加为您的网站目录的子模块。
+
+
+## 安装
+
+安装方法与 [安装主题](https://fixit.lruihao.cn/documentation/installation/) 相同。有几种安装方法,请选择一种。
+
+### 安装为 Hugo 模块
+
+首先确保你的项目本身是一个 [Hugo 模块](https://gohugo.io/hugo-modules/use-modules/#initialize-a-new-module)。
+
+然后将此主题组件添加到你的 `hugo.toml` 配置文件中:
+
+```toml
+[module]
+ [[module.imports]]
+ path = "github.com/hugo-fixit/FixIt"
+ [[module.imports]]
+ path = "github.com/hugo-fixit/shortcode-mmt-netease"
+```
+
+在第一次启动 Hugo 时,它将下载所需的文件。
+
+要更新到模块的最新版本,请运行:
```bash
-git submodule add https://github.com/Lruihao/hugo-shortcode-mmt-netease.git themes/shortcode-mmt-netease
+hugo mod get -u
+hugo mod tidy
```
-接下来编辑您的项目 `config.toml` 并将此主题组件添加到您的主题中:
+### 安装为 Git 子模块
+
+将 [FixIt](https://github.com/hugo-fixit) 和此 git 存储库克隆到你的主题文件夹中,并将其添加为网站目录的子模块。
```bash
-theme = ["your-main-theme", "shortcode-mmt-netease"]
+git submodule add https://github.com/hugo-fixit/FixIt.git themes/FixIt
+git submodule add https://github.com/hugo-fixit/shortcode-mmt-netease.git themes/shortcode-mmt-netease
```
-要了解 hugo 的主题组件以及如何使用它们,请查看 。
+接下来编辑项目的 `hugo.toml` 并将此主题组件添加到你的主题中:
+
+```toml
+theme = ["FixIt", "shortcode-mmt-netease"]
+```
-## Usage
+## 使用
`mmt-netease` shortcode 有以下命名参数:
- - **mid** *[必需]*(第一个位置参数)网易云歌单 ID
- - **autoplay** *[可选]*(第二个位置参数)是否自动播放,默认:`false`
- - **fixed** *[可选]*(第三个位置参数)是否启用固定模式,默认:`false`
- - **mini** *[可选]*(第四个位置参数)是否启用迷你模式,默认:`false`
- - **volume** *[可选]*(第五个位置参数)默认音量,注意播放器会记住用户设置,用户自己设置音量后默认音量将不起作用,默认:`0.7`
+- **mid** _[必需]_(第一个位置参数)网易云歌单 ID
+- **autoplay** _[可选]_(第二个位置参数)是否自动播放,默认:`false`
+- **fixed** _[可选]_(第三个位置参数)是否启用固定模式,默认:`false`
+- **mini** _[可选]_(第四个位置参数)是否启用迷你模式,默认:`false`
+- **volume** _[可选]_(第五个位置参数)默认音量,注意播放器会记住用户设置,用户自己设置音量后默认音量将不起作用,默认:`0.7`
这是一个用法示例:
@@ -38,7 +68,8 @@ theme = ["your-main-theme", "shortcode-mmt-netease"]
{{< mmt-netease "2280569152" false >}}
```
-> **Warning** 同一页面只支持使用一次!
+> [!Warning]
+> 同一页面只支持使用一次!
## Dependencies
diff --git a/go.mod b/go.mod
index a72a4bb..58edda7 100644
--- a/go.mod
+++ b/go.mod
@@ -1,3 +1,3 @@
-module github.com/Lruihao/hugo-shortcode-mmt-netease
+module github.com/hugo-fixit/shortcode-mmt-netease
go 1.19
diff --git a/layouts/shortcodes/mmt-netease.html b/layouts/shortcodes/mmt-netease.html
index d8524d5..d7f64b4 100644
--- a/layouts/shortcodes/mmt-netease.html
+++ b/layouts/shortcodes/mmt-netease.html
@@ -1,5 +1,5 @@
-{{- $version := "1.0.7" -}}
+{{- $version := "1.1.0" -}}
{{- $mid := cond .IsNamedParams (.Get "mid") (.Get 0) | default "2280569152" -}}
{{- $autoplay := cond .IsNamedParams (.Get "autoplay") (.Get 1) | default false -}}
{{- $fixed := cond .IsNamedParams (.Get "fixed") (.Get 2) -}}
diff --git a/theme.toml b/theme.toml
new file mode 100644
index 0000000..68ebc7b
--- /dev/null
+++ b/theme.toml
@@ -0,0 +1,21 @@
+# theme.toml template for a Hugo theme
+# See https://github.com/gohugoio/hugoThemes#themetoml for an example
+
+name = 'shortcode-mmt-netease'
+license = 'MIT'
+licenselink = 'https://github.com/hugo-fixit/shortcode-mmt-netease/LICENSE'
+description = '🎶 一个含有网易云随机评论 shortcode 的 Hugo 主题组件。'
+min_version = "0.134.1"
+
+# The home page of the theme, where the source can be found
+homepage = 'https://github.com/hugo-fixit/shortcode-mmt-netease'
+
+# Taxonomy terms
+tags = ['shortcodes']
+features = ['caniuse', "MMT", "netease"]
+
+# If the theme has a single author
+[author]
+ name = "Lruihao"
+ homepage = "https://lruihao.cn"
+