1<!-- badges -->
2<div align="right">
3
4  [![](https://img.shields.io/github/license/Hsins/dokuwiki-plugin-heatmap.svg?label=License&style=flat-square)](./LICENSE)
5
6</div>
7
8<!-- logo, title and description -->
9<div align="center">
10
11  <img src="https://github.com/user-attachments/assets/6e311c10-0644-4559-b5ea-10a432844135" alt="DokuWiki Plugin: Heatmap" height="150px" />
12
13# DokuWiki Plugin: Heatmap
14
15�� _DokuWiki plugin for showing heatmap of yearly pages with [Apache ECharts](https://echarts.apache.org/) visualization library._
16
17[![Plugin Page](https://img.shields.io/badge/PLUGIN%20PAGE--f5edcc.svg?logo=read-the-docs&style=flat-square)](https://www.dokuwiki.org/plugin:heatmap)
18[![](https://img.shields.io/badge/CHANGELOG--E08B32.svg?logo=git&style=flat-square)](./CHANGELOG.md)
19
20</div>
21
22## Installation
23
24There're roughly different 3 methods to install an extension on your DokuWiki instance:
25
26- **Method 01** — Search and install the plugin using the [Extension Manager](https://www.dokuwiki.org/plugin:extension).
27- **Method 02** — Download the extension and unpack it into `<DOKUWIKI_DIR>/lib/plugins/heatmap` on your server.
28- **Method 03** — Maintain and install with [DokuWiki Command Line Tools](https://www.dokuwiki.org/plugin:cli).
29
30Example of installing with DokuWiki Command Line Tools:
31
32``` bash
33# Install KaTeX plugin via Git.
34$ ./bin/gittool.php clone heatmap
35
36# The same as clone, but install via download when no git source can be found.
37$ ./bin/gittool.php install heatmap
38```
39
40## Usage
41
42Default with current year and all namespaces:
43
44```
45<heatmap>
46```
47
48Given namespace and year:
49
50```
51<heatmap ns=blog year=2024>
52```
53
54## Sreenshots and Demo Sites
55
56### Screenshots
57
58<table>
59<tr>
60  <th> Normal </th>
61  <th> Hover </th>
62</tr>
63<tr>
64<td align="center">
65
66![image](https://github.com/user-attachments/assets/0e1553f5-c89a-4e33-a7ee-9219420115db)
67
68</td>
69<td align="center">
70
71![image](https://github.com/user-attachments/assets/91a0128a-0df8-4bd9-80bf-a66f61b0ba53)
72
73</td>
74</tr>
75
76</table>
77
78### Demo Sites
79
80The following DokuWiki sites use the Heatmap plugin:
81
82- [OSKI](https://wiki.hsins.eu/) : Hsins' personal wiki set up experimentally using DokuWiki.
83
84> [!NOTE]
85> If you're and using Heatmap plugin on your DokuWiki instance, feel free to add it to the list ��.
86
87## Contribution
88
89This project exists thanks to all the people who contribute:
90
91<a href="https://github.com/Hsins/dokuwiki-plugin-heatmap/graphs/contributors">
92  <img src="https://contrib.rocks/image?repo=Hsins/dokuwiki-plugin-heatmap" />
93</a>
94
95## License
96
97Licensed under the GPL-3.0 License, Copyright © 2024-present **H.-H. PENG (Hsins)**.
98
99<div align="center">
100  <sub>Assembled with ❤️ in Taiwan.</sub>
101</div>