1
0
mirror of https://github.com/thebaer/cdr.git synced 2024-11-15 01:31:01 +00:00

Explain template options in README

This commit is contained in:
Matt Baer 2022-03-30 23:58:22 -04:00
parent 7e0ab6eddb
commit 11db38aa36

View File

@ -38,6 +38,44 @@ You can also tweak the original template _before_ it generates the final page.
1. Edit this file to your liking, being sure to retain the `{{template ...}}` lines in the file 1. Edit this file to your liking, being sure to retain the `{{template ...}}` lines in the file
1. Run `cdr burn` -- it'll generate your page from this template instead of the default! 1. Run `cdr burn` -- it'll generate your page from this template instead of the default!
### Template parts
These are the full template codes you can use to include certain elements.
#### Player + Playlist
This shows the audio player with play / pause actions, plus the playlist. You don't need to use any other template codes beyond this.
```
{{template "full-player" .Tracks}}
```
#### Granular Elements
Optionally, you can use these more granular template codes for better control over your mixtape.
**IMPORTANT!** When using anything besides the `full-player` code, you will ALWAYS want to include the following code in your template. Otherwise your mixtape won't work well!
```
{{template "playlist-js"}}
```
#### Player
Shows only the audio player.
```
{{template "player" .Tracks}}
```
#### Playlist
Show the playlist of tracks on the mixtape.
```
{{template "playlist" .Tracks}}
```
### Developers ### Developers
Requires Go 1.16 and above. Requires Go 1.16 and above.