summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 5 insertions, 12 deletions
diff --git a/README.md b/README.md
index 66f630a..5925774 100644
--- a/README.md
+++ b/README.md
@@ -95,21 +95,14 @@ showComments = false # Do not show comments in this post
### 🎵 APlayer
-In-post APlayer supported, you can set these variables in post's front matter:
+In-post APlayer supported, you use the `aplayer` shortcode:
-```toml
-[[player]]
- playerName = "..." # Audio title or name
- playerArtist = "..." # Audio artist
- playerURL = "..." # Audio URL, support aac, mp3, wav and ogg
- playerCover = "..." # Audio cover
-[[player]]
- playerName = "..."
- playerArtist = "..."
- playerURL = "..."
- playerCover = "..."
+```txt
+{{< aplayer urls="/aplayer/fluid.mp3" names="Fluid" artists="Crowander" covers="/aplayer/crowander.jpg" >}}
```
+Checkout the `exampleSite/content/post/aplayer-test.md` for more example usage such as using multiple files.
+
### 📐 Render LaTeX with KaTex
You can write LaTeX directly in markdown with escape characters: