mirrors/mycorrhiza
1
0
Fork 0
mirror of https://github.com/osmarks/mycorrhiza.git synced 2025-08-05 21:33:49 +00:00
Code Issues Releases Wiki Activity

Update README.md for 0.12

Browse Source
This commit is contained in:
bouncepaw 2021-01-24 13:33:51 +05:00
parent 9316e671b6
commit 225c83d851
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,7 +1,10 @@
# 🍄 MycorrhizaWiki 0.12 # 🍄 MycorrhizaWiki 0.12
A wiki engine. A wiki engine.
[Main wiki](https://mycorrhiza.lesarbr.es)
## Building ## Building
Also see [detailed instructions](https://mycorrhiza.lesarbr.es/page/deploy) on wiki.
```sh ```sh
git clone --recurse-submodules https://github.com/bouncepaw/mycorrhiza git clone --recurse-submodules https://github.com/bouncepaw/mycorrhiza
cd mycorrhiza cd mycorrhiza
@ -37,8 +40,8 @@ Options:
``` ```
## Features ## Features
* Edit pages through html forms * Edit pages through html forms, graphical preview
* Responsive design * Responsive design, dark theme (synced with system theme)
* Works in text browsers * Works in text browsers
* Wiki pages (called hyphae) are written in mycomarkup * Wiki pages (called hyphae) are written in mycomarkup
* Everything is stored as simple files, no database required. You can run a wiki on almost any directory and get something to work with * Everything is stored as simple files, no database required. You can run a wiki on almost any directory and get something to work with
@ -50,12 +53,10 @@ Options:
* Recent changes page; RSS, Atom and JSON feeds available * Recent changes page; RSS, Atom and JSON feeds available
* Hyphae can be deleted (while still preserving history) * Hyphae can be deleted (while still preserving history)
* Hyphae can be renamed (recursive renaming of subhyphae is also supported) * Hyphae can be renamed (recursive renaming of subhyphae is also supported)
* Light on resources: I run a home wiki on this engine 24/7 at an [Orange π Lite](http://www.orangepi.org/orangepilite/) * Light on resources
* Authorization with pre-set credentials * Authorization with pre-set credentials
## Contributing ## 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. Help is always needed. We have a [tg chat](https://t.me/mycorrhizadev) where some development is coordinated. You can also sponsor on [boosty](https://boosty.to/bouncepaw). Feel free to open an issue or contact directly.
## Future plans You can view list of all planned features on [our kanban board](https://github.com/bouncepaw/mycorrhiza/projects/1).
* Tagging system
* Better history viewing