README.md
1# colorswatch Plugin for DokuWiki
2
3Display a color swatch of the given color.
4
5![Screenshot](docs/screenshot_dokuwiki_colorswatch.png?raw=true "Screenshot")
6
7A colorswatch can contain only a hexadecimal color code
8
9 <colorswatch #FFFF00>
10
11or a color code and a name
12
13 <colorswatch #FFFF00:some_yellow>
14
15The plugin only supports hexadecimal color codes (the ones starting with ``#``), no functions like ``rgb()`` or ``hsla()`` or keywords like ``lightgray`` or ``fuchsia``. In the plugin's settings, it's possible to choose between tiny, small, medium-sized, and large color swatches. The size setting is global and changes get applied the next time the wiki page with the color swatches in them is saved.
16
17All documentation for this plugin can be found at
18https://github.com/hkockerbeck/dokuwiki_colorswatch
19
20If you install this plugin manually, make sure it is installed in lib/plugins/colorswatch/ - if the folder is called different it will not work!
21
22Please refer to http://www.dokuwiki.org/plugins for additional info on how to install plugins in DokuWiki.
23
24# License
25
26Copyright (C) Henning Kockerbeck <henning.kockerbeck@isatis-online.de>
27
28This program is free software; you can redistribute it and/or modify
29it under the terms of the GNU General Public License as published by
30the Free Software Foundation; version 2 of the License
31
32This program is distributed in the hope that it will be useful,
33but WITHOUT ANY WARRANTY; without even the implied warranty of
34MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
35GNU General Public License for more details.
36
37See the LICENSE file for details
38