khum1/README.md

52 lines
2.2 KiB
Markdown

# Khum1, Dokuwiki template for Khaganat
## Description
This template is based on default Dokuwiki template (version available on 2020-04-09).
It try to be responsive and accessible.
Design is for Khaganat, a wonderful open project. Feel free to use it if you Dokuwiki is inspired by Khaganat ; probably better to adapt it at your taste if you have an other project.
It s better with [sidebar](https://www.dokuwiki.org/faq:sidebar). Wiki without sidebar are like a dishes without salt.
## Plugin support
Khum1 is designed to integrate certain plugins in particular. They have special css or hack on the template. It work without this plugin too !
* [Children pages](https://forge.dotslashplay.it/vv221/dokuwiki-childrenpages) to have tab on top article
* [Translation](http://www.dokuwiki.org/plugin:translation).
It work well with a lot of plugin too, without hack :)
## Installation
When this template is ready:
Install it like any other template. Do "search and install" in the extension manager, find "Khum1", select and install it.
Manually :
Download the folder, rename it "khum1" if it has another name, and put it in 'dokuwki/lib/tpl/'.
And after, choose it in admin configuration.
## Support and contributing
Please consider that I'm not a real developper. I accept merge request, but probably I can't debug issue.
I am really happy if you know how make it better. Contribute as you can, I integrate it if I understand !
If you see a bug, please create an issue on [my depot](https://git.khaganat.net/khaganat/web/dokuwiki/khum1/-/issues) or send me a mail to [zatalyz.khum1@liev.re](zatalyz.khum1@liev.re). I try to resolve when I can, or find people who can resolve it.
## Changelog
I try to follow [Keep a Changelog](https://keepachangelog.com/fr/1.0.0/). Changelog ar in an other file.
## Credits
All real work has made by Anika Henke and Clarence Lee (see [Dokuwiki default template credits](https://www.dokuwiki.org/template:dokuwiki)).
Change on this template :
* Zatalyz (design, hack, css)
* help of a lot of people on Khaganat to test, find good idea, explain how code work.
* YannK (background images and advices)
## License
Dokuwiki is on GPL, so this plugin too. More easy and legal.
Share is an act of love, so feel you free.