xref: /template/writr/README.md (revision d7f2920fab2f9867096ad7b0e16ef708e7b9bf73)
1<p align="center"><img src="images/logo.png" /></p>
2
3# [Writr Template](https://www.dokuwiki.org/template:writr)
4![License](https://img.shields.io/github/license/LaswitchTech/writr?style=for-the-badge)
5![GitHub repo size](https://img.shields.io/github/repo-size/LaswitchTech/writr?style=for-the-badge&logo=github)
6![GitHub top language](https://img.shields.io/github/languages/top/LaswitchTech/writr?style=for-the-badge)
7![Version](https://img.shields.io/github/v/release/LaswitchTech/writr?label=Version&style=for-the-badge)
8
9## Description
10**Author(s)**: [Louis Ouellet](louis_ouellet@hotmail.com), [Anika Henke](anika@selfthinker.org)
11
12This template was converted from the WordPress theme Writr. It was voted for by [DokuWiki](https://www.dokuwiki.org) users from a selection of 19 other WordPress themes to convert.
13
14## Features
15- Improve the general aesthetic for a more modern look and consistency
16- Personalize using template's configurations and template's style configurations
17- Support for Bootstrap Icons
18- Support for many DokuWiki Plugins
19- A new toolbar is now available in the template configuration. Based on the original WordPress Theme Writr.
20- A new set of tooltips is now available in the template configuration.
21- Hide/Show Site-Tools based on user login. (CMS mode)
22- Set Site Identity per namespace including Logo, Title, Link and Tagline
23
24## License
25This software is distributed under the [GPL2](COPYING) license.
26
27## Security
28Please disclose any vulnerabilities found responsibly – report security issues to the maintainers privately. See [SECURITY.md](SECURITY.md) for more information.
29
30## Contributing
31Contributions to Writr are welcome! If you have ideas for new features or have found bugs, please open an issue or submit a pull request.
32
33### How to Contribute
34  - **Fork the Repository**: Create a fork of the repository on GitHub.
35  - **Create a New Branch**: For new features or bug fixes, create a new branch in your fork.
36  - **Submit a Pull Request**: Once your changes are ready, submit a pull request to the main repository.
37
38## Acknowledgments
39  - **Based on [Writr Theme](https://wordpress.com/themes/writr/)**  (version 1.2.3) for WordPress by [Automattic](https://automattic.com/)
40  - **Based on [Underscores](http://underscores.me/)** by [Automattic](https://automattic.com/).
41  - **Resetting and rebuilding styles** have been helped along thanks to the work of [Eric Meyer](http://meyerweb.com/eric/tools/css/reset/index.html) along with Nicolas Gallagher and [Jonathan Neal](http://necolas.github.com/normalize.css/) and [Blueprint](http://www.blueprintcss.org/).
42
43## Wait, where is the documentation?
44Review the [Documentation](https://laswitchtech.com/en/blog/projects/writr/index).
45
46## GitHub Stats
47![Alt](https://repobeats.axiom.co/api/embed/b287c1867e50d7abd181fed102056c6d5024c053.svg "Repobeats analytics image")
48