mirrors/mycorrhiza
1
0
Fork 0
mirror of https://github.com/osmarks/mycorrhiza.git synced 2024-12-13 05:50:27 +00:00
Code Issues Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
handlerug 2021-07-02 01:52:59 +07:00
parent a9e7878741
commit e6265c9ad9
No known key found for this signature in database
GPG Key ID: 38009F0605051491
1 changed files with 36 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

108
README.md
View File

@ -1,84 +1,48 @@
# 🍄 Mycorrhiza Wiki 1.2 # 🍄 Mycorrhiza Wiki
<img src="https://mycorrhiza.lesarbr.es/binary/release/1.2/screenshot" alt="A screenshot of Mycorrhiza Wiki home hypha in the Safari browser" width="500"> <img src="https://mycorrhiza.wiki/binary/release/1.2/screenshot" alt="A screenshot of Mycorrhiza Wiki's home page in the Safari browser" width="500">
**Mycorrhiza Wiki** is a filesystem and git-based wiki engine. **Mycorrhiza Wiki** is a filesystem-backed wiki engine using Git for keeping
history.
[Main wiki](https://mycorrhiza.lesarbr.es) [Main wiki](https://mycorrhiza.wiki)
## Usage
```
mycorrhiza [OPTIONS...] WIKI_PATH
WIKI_PATH must be a path to a 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 ## Features
* Wiki pages (called hyphae) are written in Mycomarkup
* Edit pages through HTML forms, a graphical preview and a toolbar that helps you use Mycomarkup
* Responsive design, dark theme (synced with system theme)
* Works in text browsers
* 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
* Registration
* Hotkeys (press `?` to see what hotkeys there are)
## Building * **No database required.** Everything is stored as simple files. It makes installation super easy, and you can modify the content with other means such as direct file editing.
See [the guide](https://mycorrhiza.lesarbr.es/hypha/guide/deployment) on the wiki. * **Everything is hyphae.** A [hypha][feature-hypha] is a unit of content such as a picture, video or a text article. Hyphae can [transclude][feature-transclusion] and [link][mycomarkup-link] each other resulting in a tight network of hypertext pages.
* **Hyphae are authored in [Mycomarkup][mycomarkup],** a custom markup language that's designed to be unambigious and easy to use.
* **Nesting of hyphae** is supported. A tree of related hyphae is shown on every page.
* **History of changes** for textual parts of hyphae. Every change is safely stored in [Git][integration-git]. Web feeds for recent changes included!
* **Keyboard-driven navigation.** Press `?` to see the list of shortcuts.
* **Support for [authorization][feature-authorization].**
* **[Opengraph][standard-og] support.**
[feature-hypha]: https://mycorrhiza.wiki/hypha/feature/hypha
[feature-transclusion]: https://mycorrhiza.wiki/hypha/feature/transclusion
[feature-authorization]: https://mycorrhiza.wiki/hypha/feature/authorization
[mycomarkup]: https://mycorrhiza.wiki/hypha/mycomarkup
[mycomarkup-link]: https://mycorrhiza.wiki/hypha/mycomarkup/link
[integration-git]: https://mycorrhiza.wiki/hypha/integration/git
[standard-og]: https://mycorrhiza.wiki/hypha/standard/opengraph
## Installing ## Installing
### AUR See [the deployment guide][deployment] on the wiki.
You can install Mycorrhiza Wiki from AUR using your favorite package manager on any Arch Linux-derivative distro (Arch, Manjaro, Garuda, etc):
```sh
# Build from sources
yay -S mycorrhiza
# OR
# Use pre-built binaries from the Releases page
yay -S mycorrhiza-bin
```
### Docker [deployment]: https://mycorrhiza.wiki/hypha/guide/deployment
You can run Mycorrhiza Wiki in Docker using Dockerfile provided by this repository. Clone the repo and build the image:
```sh
git clone https://github.com/bouncepaw/mycorrhiza/
docker build -t mycorrhiza .
```
Now you can create a new Mycorrhiza Wiki container using this command:
```sh
docker run -v /path/to/wiki:/wiki -p 1737:1737 mycorrhiza
```
Example:
```sh
cd /dev/shm
git clone https://github.com/bouncepaw/mycorrhiza/
docker build -t mycorrhiza .
git clone https://github.com/bouncepaw/example-wiki
docker run -v /dev/shm/example-wiki:/wiki -p 1737:1737 mycorrhiza
```
Example 2:
```sh
# ...
docker run -v /dev/shm/:/config -v /dev/shm/example-wiki:/wiki -p 80:1737 mycorrhiza -config-path /config/myconfig.ini /wiki
```
## Contributing ## Contributing
We always need help. We have a [Telegram chat](https://t.me/mycorrhizadev) where we coordinate development. You can also sponsor @bouncepaw on [Boosty](https://boosty.to/bouncepaw). Feel free to open an issue or contact us directly.
You can view list of many planned features on [our kanban board](https://github.com/bouncepaw/mycorrhiza/projects/1). Help is always welcome! We have a [Telegram chat][tg] for development
discussions. You can also sponsor the maintainer of Mycorrhiza,
[@bouncepaw][bp], on [Boosty][bp-donate]. If you want to contribute with code,
you can either open a pull request on GitHub or send a patch to the [mailing
list][mlist]. Feel free to open an issue on GitHub or contact us directly.
[tg]: https://t.me/mycorrhizadev
[bp]: https://github.com/bouncepaw
[bp-donate]: https://boosty.to/bouncepaw
[mlist]: https://lists.sr.ht/~handlerug/mycorrhiza-devel
You can view the list of planned features at [our GitHub project kanban
board](https://github.com/bouncepaw/mycorrhiza/projects/1).