khum1/README.md

2.3 KiB

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. 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 !

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 !

Special Git tricks (because I always forgot)

git clone ssh://git@git.khaganat.net:3543/zatalyz/khum1-doku.git
cd khum1-doku

And after

git pull ssh://git@git.khaganat.net:3543/zatalyz/khum1-doku.git
git add *
git commit -m "Blabla"
git push -u origin master

Changelog Try to follow Keep a Changelog. Changelog ar in an other file.

Credits

All real work has made by Anika Henke and Clarence Lee (see Dokuwiki default template credits).

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.