mycorrhiza/README.md

# 🍄 MycorrhizaWiki 1.1
A wiki engine.

[Main wiki](https://mycorrhiza.lesarbr.es)

## Building
Also see [detailed instructions](https://mycorrhiza.lesarbr.es/hypha/deploy) on wiki.
```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.
```

## Usage
```
mycorrhiza [OPTIONS...] WIKI_PATH

WIKI_PATH must be a path to git repository which you want to be a wiki.

Options:
  -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.
```

## Features
* Edit pages through html forms, graphical preview
* Responsive design, dark theme (synced with system theme)
* Works in text browsers
* 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
* Page trees; links to previous and next pages
* Changes are saved to git
* List of hyphae page
* History page
* Random page
* Recent changes page; RSS, Atom and JSON feeds available
* Hyphae can be deleted (while still preserving history)
* Hyphae can be renamed (recursive renaming of subhyphae is also supported)
* Light on resources
* Authorization with pre-set credentials
* Basic Gemini protocol support

## Contributing
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.

You can view list of all planned features on [our kanban board](https://github.com/bouncepaw/mycorrhiza/projects/1).
Update README.md 2021-03-19 14:01:14 +00:00			`# 🍄 MycorrhizaWiki 1.1`
A better README.md for 0.8 release 2020-09-01 16:52:40 +00:00			`A wiki engine.`

Update README.md for 0.12 2021-01-24 08:33:51 +00:00			`[Main wiki](https://mycorrhiza.lesarbr.es)`

Some cleanup 2020-10-03 17:05:10 +00:00			`## Building`
Support configuration files See https://mycorrhiza.lesarbr.es/hypha/configuration for an example. A copy of this example is stored at assets/config.ini. Use option -config-path to pass the config file. Note that all other CLI options have been removed. Some of them may be returned later. Also note that no real testing has been done. 2021-03-06 09:40:47 +00:00			`Also see [detailed instructions](https://mycorrhiza.lesarbr.es/hypha/deploy) on wiki.`
A better README.md for 0.8 release 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.
			```
Verify presence of mycelial dirs, start moving to new file structure 2020-07-02 19:03:30 +00:00
Implement CLI args 2020-10-25 15:06:51 +00:00			`## Usage`
			```
			`mycorrhiza [OPTIONS...] WIKI_PATH`

Edit README.md 2020-11-27 18:27:50 +00:00			`WIKI_PATH must be a path to git repository which you want to be a wiki.`

Implement CLI args 2020-10-25 15:06:51 +00:00			`Options:`
Write 1.0 version 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.`
Implement CLI args 2020-10-25 15:06:51 +00:00			```

Some cleanup 2020-10-03 17:05:10 +00:00			`## Features`
Update README.md for 0.12 2021-01-24 08:33:51 +00:00			`* Edit pages through html forms, graphical preview`
			`* Responsive design, dark theme (synced with system theme)`
write a better readme 2020-07-19 15:00:44 +00:00			`* Works in text browsers`
Get ready for 0.10 release 2020-11-11 16:55:36 +00:00			`* Wiki pages (called hyphae) are written in mycomarkup`
Update README.md 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`
Some changes 2020-08-28 19:10:46 +00:00			`* Changes are saved to git`
A better README.md for 0.8 release 2020-09-01 16:52:40 +00:00			`* List of hyphae page`
Some changes 2020-08-28 19:10:46 +00:00			`* History page`
A better README.md for 0.8 release 2020-09-01 16:52:40 +00:00			`* Random page`
Update README.md 2020-12-08 15:26:18 +00:00			`* Recent changes page; RSS, Atom and JSON feeds available`
Some cleanup 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)`
Update README.md for 0.12 2021-01-24 08:33:51 +00:00			`* Light on resources`
Edit README.md 2020-11-27 18:27:50 +00:00			`* Authorization with pre-set credentials`
Some adjusting before merging 2021-03-05 09:39:33 +00:00			`* Basic Gemini protocol support`
write a better readme 2020-07-19 15:00:44 +00:00
A better README.md for 0.8 release 2020-09-01 16:52:40 +00:00			`## Contributing`
Update README.md for 0.12 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.`
write a better readme 2020-07-19 15:00:44 +00:00
Update README.md for 0.12 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).`