Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hugo-fixit/shortcode-rewards
A Hugo theme component with reward-log or sponsor-log shortcode.
https://github.com/hugo-fixit/shortcode-rewards
hugo reward-log shortcodes theme-component
Last synced: 3 months ago
JSON representation
A Hugo theme component with reward-log or sponsor-log shortcode.
- Host: GitHub
- URL: https://github.com/hugo-fixit/shortcode-rewards
- Owner: hugo-fixit
- License: mit
- Created: 2024-07-21T14:02:29.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-07-24T10:22:31.000Z (6 months ago)
- Last Synced: 2024-10-30T09:56:14.526Z (3 months ago)
- Topics: hugo, reward-log, shortcodes, theme-component
- Language: HTML
- Homepage: https://lruihao.cn/reward/
- Size: 27.3 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# shortcode-rewards
A Hugo theme component with `reward-log` or `sponsor-log` shortcode.
## Demo
- [FixIt Docs](https://fixit.lruihao.cn/contributing/overview/#sponsor)
- [Lruihao's Blog](https://lruihao.cn/about/#sponsor)
## Requirements
> Developed based on the FixIt Timeline plugin.
- FixIt v0.3.9 or later.
## Install Component
The installation method is the same as [installing a theme](https://fixit.lruihao.cn/documentation/installation/). There are several ways to install, choose one, for example, install through Hugo Modules:
```diff
[module]
[[module.imports]]
path = "github.com/hugo-fixit/FixIt"
+ [[module.imports]]
+ path = "github.com/hugo-fixit/shortcode-rewards"
```
## Inject Partial
Inject the `shortcode-rewards.html` into the `custom-head` through the custom block opened by the FixIt theme in the `layouts/partials/custom.html` file:
```go-html-template
{{- define "custom-head" -}}
{{- partial "inject/shortcode-rewards.html" . -}}
{{- end -}}
```
## Usage
First, create the `reward-log.yml` file and edit your data:
```bash
cp themes/shortcode-sponsor-log/reward_log.yml.example data/reward_log.yml
```
> If your site is multilingual, you can create a `reward_log.en.yml` file for English and `reward_log.zh-cn.yml` for Chinese.
Next, use the `reward-log` shortcode in any page:
```markdown
{{< reward-log >}}
```
> [!note]
> For compatibility with older versions, `sponsor-log` shortcode can also be used, and the corresponding data file is `sponsor_log.yml`.
## Params
### Shortcode
The `reward-log` shortcode has the following named parameters, and the positional parameters ordered from top to bottom:
| Parameter | Description | Type | Optional values | Default |
| :-------- | :---------------------------------------------------------------- | :------ | :--------------------- | :------ |
| reverse | whether the node is ascending or descending, default is ascending | boolean | - | false |
| placement | position of timestamp | string | top / bottom | bottom |
| animation | whether to enable animation | boolean | - | false |
| size | node size | string | small / medium / large | medium |
| node | node style | string | circle / dot | circle |
| width | `#` container width | string | - | - |
| height | `#` container height | string | - | - |
| class | `#` container classname | string | - | - |
> Parameters marked with `#` only support named parameters.
### Data
The `reward_log.yml` file has the following fields:
```yaml
# The sponsor logs data format is as follows
# currency: [CNY, USD, EUR, ...] https://gohugo.io/functions/lang/formatcurrency/
# origin: [alipay, bitcoin, paypal, wechatpay, ...]
message: Thanks all!
currency: CNY
symbol: ¥
# The sponsor logs inherit the FixIt Timeline events
logs:
- date: "2006-01-02 15:04:05"
sponsor: Cell
money: 50
origin: alipay
remark: "Come on!"
```
## References
- [Develop Theme Components | FixIt](https://fixit.lruihao.cn/contributing/components/)
- [How to Develop a Hugo Theme Component | FixIt](https://fixit.lruihao.cn/components/dev-component/)