diff options
Diffstat (limited to 'plugins/55/gitbacked/README.md')
| -rw-r--r-- | plugins/55/gitbacked/README.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/plugins/55/gitbacked/README.md b/plugins/55/gitbacked/README.md new file mode 100644 index 0000000..03532f0 --- /dev/null +++ b/plugins/55/gitbacked/README.md @@ -0,0 +1,46 @@ +# gitbacked Plugin for DokuWiki + +## :green_heart: Contributions welcome :green_heart: + +You want to support Open Source, even if you are new to the game? +Feel free to grab an issue: + +- [Smaller issues, also well suited for newcomers](https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues?q=is%3Aissue+is%3Aopen+label%3Acontributionwelcome) +- [Feature requests and other cool ideas](https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues?q=is%3Aissue+is%3Aopen+label%3A%22feature+request%22) + +If you have encountered a problem, you have a good idea, or just have a question, please, create a new issue. + +## gitbacked Plugin for DokuWiki + +Store/Sync pages and media files in a git repository + +All documentation for this plugin can be found at +http://www.dokuwiki.org/plugin:gitbacked + +This plugin is provided as released DokuWiki installable ZIP packages with detailed [release notes](https://github.com/woolfg/dokuwiki-plugin-gitbacked/blob/master/CHANGELOG.md) +via this repos [Releases](https://github.com/woolfg/dokuwiki-plugin-gitbacked/releases). +Detailed technical information on how releases are built can be found at [HowTo manage releases](https://github.com/woolfg/dokuwiki-plugin-gitbacked/blob/master/.github/workflows/docs/HowTo_MANAGE_RELEASES.md). + +If you install this plugin manually, make sure that: +- you download a **released** `dokuwiki-plugin-gitbacked-YYYY-DD-MM.zip` file + from the [Release](https://github.com/woolfg/dokuwiki-plugin-gitbacked/releases) page. +- this file is to be unpacked in `<DOKUWIKI_ROOT>/lib/plugins/gitbacked/` - if this folder + is called differently it will not work! + +Please refer to http://www.dokuwiki.org/plugins for additional info +on how to install plugins in DokuWiki. + +## Changelog + +See [CHANGELOG.md](CHANGELOG.md) + +## Maintainers + +- [@mhoffrog (Markus Hoffrogge)](https://github.com/mhoffrog) +- [@woolfg (Wolfgang Gassler)](https://github.com/woolfg) + +## License + +This plugin is licensed under GPLv2, see [LICENSE](LICENSE). + +See the [COPYING](https://github.com/splitbrain/dokuwiki/blob/master/COPYING) file in your DokuWiki folder for details |