Feat: 修改包名为 github.com/hugo-fixit/shortcode-mmt-netease

原包 github.com/Lruihao/hugo-shortcode-mmt-netease 保留在 legacy 分支

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://lruihao.cn/guestbook/>
+
+## 安装
+
+安装方法与 [安装主题](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 的主题组件以及如何使用它们，请查看 <https://gohugo.io/hugo-modules/theme-components/>。
+接下来编辑项目的 `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
 

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

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) -}}

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"
+