1# Iconify Plugin for Dokuwiki
2
3This plugin allows you to easily insert [Iconify](https://iconify.design) icons into your Dokuwiki pages using a simple syntax.
4
5## Documentation
6
7All documentation for this plugin can be found at
8http://www.dokuwiki.org/plugin:iconify
9
10## Installation
11
12Search and install the plugin using the Extension Manager https://www.dokuwiki.org/plugin:extension.
13If you install this plugin manually, make sure it is installed in
14lib/plugins/iconify/ - if the folder is called different it
15will not work!
16
17Please refer to http://www.dokuwiki.org/extensions for additional info
18on how to install extensions in DokuWiki.
19
20## Configuration
21
22### Default Icon Size
23You can configure a default size for icons (e.g., `32px`) in the plugin settings. Default size is `24px`.
24
25### Local or Online Mode
26You can choose between loading the Iconify library from the internet or using a local file:
27
28- **Local Mode:** Place the `iconify.min.js` file in the `lib/plugins/iconify/local/` folder. Enable the "Use local file" option in the plugin settings.
29- **Online Mode:** The plugin will load the library from the internet using the version specified in the settings or fetch the latest version dynamically.
30
31If the local mode is enabled but the file is not found, the plugin will log an error.
32
33### Iconify Version for Online Mode
34You can configure the version of the Iconify library via the plugin settings. Specify the desired version (e.g., `3.1.1`) or use `latest` to dynamically fetch the most recent version from the CDNJS API.
35
36If the `latest` option is selected, the plugin will fetch the latest version available on CDNJS at runtime.
37
38In case of an error with the API, the plugin will fall back to version `3.1.1`.
39
40Go to the plugin settings page in the Dokuwiki admin panel to configure these options.
41
42## License
43
44Copyright (C) Tokano <contact@tokano.fr>
45
46This program is free software; you can redistribute it and/or modify
47it under the terms of the GNU General Public License as published by
48the Free Software Foundation; version 2 of the License
49
50This program is distributed in the hope that it will be useful,
51but WITHOUT ANY WARRANTY; without even the implied warranty of
52MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
53GNU General Public License for more details.
54
55See the LICENSING file for details
56