1
0
mirror of https://github.com/osmarks/mycorrhiza.git synced 2024-10-30 11:46:16 +00:00
mycorrhiza/README.md

36 lines
1005 B
Markdown
Raw Normal View History

2020-09-01 16:52:40 +00:00
# 🍄 MycorrhizaWiki 0.8
A wiki engine.
## Installation
```sh
git clone --recurse-submodules https://github.com/bouncepaw/mycorrhiza
cd mycorrhiza
make
# That make will:
# * run the default wiki. You can edit it right away.
# * create an executable called `mycorrhiza`. Run it with path to your wiki.
```
2020-07-19 15:00:44 +00:00
## Current features
* Edit pages through html forms
* Responsive design
* Works in text browsers
2020-09-01 16:52:40 +00:00
* Wiki pages (called hyphae) are in gemtext
2020-07-19 15:00:44 +00:00
* Everything is stored as simple files, no database required
2020-08-28 19:10:46 +00:00
* Page trees
* Changes are saved to git
2020-09-01 16:52:40 +00:00
* List of hyphae page
2020-08-28 19:10:46 +00:00
* History page
2020-09-01 16:52:40 +00:00
* Random page
* Light on resources: I run a home wiki on this engine 24/7 at an [Orange π Lite](http://www.orangepi.org/orangepilite/).
2020-07-19 15:00:44 +00:00
2020-09-01 16:52:40 +00:00
## Contributing
Help is always needed. We have a [tg chat](https://t.me/mycorrhizadev) where some development is coordinated. Feel free to open an issue or contact me.
2020-07-19 15:00:44 +00:00
2020-09-01 16:52:40 +00:00
## Future plans
* Tagging system
* Authorization
* Better history viewing
* Recent changes page
* More markups