2021-05-01 16:26:21 +00:00
# 🍄 MycorrhizaWiki 1.2
2020-09-01 16:52:40 +00:00
A wiki engine.
2021-01-24 08:33:51 +00:00
[Main wiki ](https://mycorrhiza.lesarbr.es )
2020-10-03 17:05:10 +00:00
## Building
2021-05-25 07:35:41 +00:00
See [the guide ](https://mycorrhiza.lesarbr.es/hypha/guide/deployment ) on the wiki.
2020-07-02 19:03:30 +00:00
2020-10-25 15:06:51 +00:00
## Usage
```
mycorrhiza [OPTIONS...] WIKI_PATH
2020-11-27 18:27:50 +00:00
WIKI_PATH must be a path to git repository which you want to be a wiki.
2020-10-25 15:06:51 +00:00
Options:
2021-03-14 15:34:24 +00:00
-config-path string
Path to a configuration file. Leave empty if you don't want to use it.
-print-example-config
If true, print an example configuration file contents and exit. You can save the output to a file and base your own configuration on it.
2020-10-25 15:06:51 +00:00
```
2020-10-03 17:05:10 +00:00
## Features
2021-05-01 07:10:26 +00:00
* Wiki pages (called hyphae) are written in mycomarkup
* Edit pages through html forms, graphical preview, toolbar that helps you use the markup
2021-01-24 08:33:51 +00:00
* Responsive design, dark theme (synced with system theme)
2020-07-19 15:00:44 +00:00
* Works in text browsers
2020-12-08 15:26:18 +00:00
* Everything is stored as simple files, no database required. You can run a wiki on almost any directory and get something to work with
* Page trees; links to previous and next pages
2020-08-28 19:10:46 +00:00
* 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
2020-12-08 15:26:18 +00:00
* Recent changes page; RSS, Atom and JSON feeds available
2020-10-03 17:05:10 +00:00
* Hyphae can be deleted (while still preserving history)
* Hyphae can be renamed (recursive renaming of subhyphae is also supported)
2021-01-24 08:33:51 +00:00
* Light on resources
2021-05-01 07:10:26 +00:00
* Authorization with pre-set credentials, registration
2021-03-05 09:39:33 +00:00
* Basic Gemini protocol support
2020-07-19 15:00:44 +00:00
2020-09-01 16:52:40 +00:00
## Contributing
2021-01-24 08:33:51 +00:00
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.
2020-07-19 15:00:44 +00:00
2021-01-24 08:33:51 +00:00
You can view list of all planned features on [our kanban board ](https://github.com/bouncepaw/mycorrhiza/projects/1 ).
