2021-01-24 12:52:40 +00:00
# 🍄 MycorrhizaWiki 0.13
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-01-24 08:33:51 +00:00
Also see [detailed instructions ](https://mycorrhiza.lesarbr.es/page/deploy ) on wiki.
2020-09-01 16:52:40 +00:00
```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-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:
2020-11-13 18:45:42 +00:00
-auth-method string
What auth method to use. Variants: "none", "fixed" (default "none")
-fixed-credentials-path string
Used when -auth-method=fixed. Path to file with user credentials. (default "mycocredentials.json")
2021-01-24 08:40:17 +00:00
-header-links-hypha string
Optional hypha that overrides the header links
2020-10-25 15:06:51 +00:00
-home string
The home page (default "home")
2021-01-23 13:45:17 +00:00
-icon string
What to show in the navititle in the beginning, before the colon (default "🍄")
-name string
What is the name of your wiki (default "wiki")
2020-10-25 15:06:51 +00:00
-port string
Port to serve the wiki at (default "1737")
2020-12-08 15:26:18 +00:00
-url string
URL at which your wiki can be found. Used to generate feeds (default "http://0.0.0.0:$port")
2021-01-23 16:37:29 +00:00
-user-hypha string
2020-11-13 18:45:42 +00:00
Hypha which is a superhypha of all user pages (default "u")
2020-10-25 15:06:51 +00:00
```
2020-10-03 17:05:10 +00:00
## Features
2021-01-24 08:33:51 +00:00
* Edit pages through html forms, graphical preview
* Responsive design, dark theme (synced with system theme)
2020-07-19 15:00:44 +00:00
* Works in text browsers
2020-11-11 16:55:36 +00:00
* Wiki pages (called hyphae) are written in mycomarkup
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
2020-11-27 18:27:50 +00:00
* Authorization with pre-set credentials
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 ).
