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

Update README.md

Browse Source
This commit is contained in:
Umar Getagazov 2021-11-10 18:43:20 +07:00
parent 82014ce3f4
commit e885d01532
1 changed files with 27 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
README.md
View File

@ -1,19 +1,20 @@
# 🍄 Mycorrhiza Wiki # 🍄 Mycorrhiza Wiki
**Mycorrhiza Wiki** is a lightweight file-system wiki engine that uses Git for keeping history. [Main wiki](https://mycorrhiza.wiki) **Mycorrhiza Wiki** is a lightweight file-system wiki engine that uses Git for keeping history. [Main wiki](https://mycorrhiza.wiki)
<img src="https://mycorrhiza.wiki/binary/release/1.4/screenshot" alt="A screenshot of mycorrhiza.wiki's home page in the Safari browser" width="600"> <img src="https://mycorrhiza.wiki/binary/release/1.6/screenshot" alt="A screenshot of mycorrhiza.wiki's home page in the Safari browser" width="600">
## Features ## Features
* **No database required.** Everything is stored in plain files. It makes installation super easy, and you can modify the content directly by yourself. * **No database required.** Everything is stored in plain files. It makes installation super easy, and you can modify the content directly by yourself.
* **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 each other resulting in a tight network of hypertext pages. * **Everything is hyphae.** A [hypha] is a unit of content such as a picture, video or a text article. Hyphae can [transclude][transclusion] and 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. * **Hyphae are authored in [Mycomarkup],** a markup language that's designed to be unambigious yet easy to use.
* **Nesting of hyphae** is supported. A tree of related hyphae is shown on every page. * **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! * **History of changes** for textual parts of hyphae. Every change is safely stored in [Git]. Web feeds for recent changes included!
* **Keyboard-driven navigation.** Press `?` to see the list of shortcuts. * **Keyboard-driven navigation.** Press `?` to see the list of shortcuts.
* **Support for [authorization][feature-authorization].** * **Support for [authorization].**
* **[Opengraph][standard-og] support.** * **[Opengraph] support.**
* **Optional [Telegram][telegram] authentication.** * **Optional [Telegram] authentication.**
Compare Mycorrhiza Wiki with other engines on [WikiMatrix](https://www.wikimatrix.org/show/mycorrhiza). Compare Mycorrhiza Wiki with other engines on [WikiMatrix](https://www.wikimatrix.org/show/mycorrhiza).
@ -23,29 +24,27 @@ See [the deployment guide](https://mycorrhiza.wiki/hypha/guide/deployment) on th
## Contributing ## Contributing
Help is always welcome! We have an IRC channel [#mycorrhiza on Help is always welcome! We have an IRC channel [#mycorrhiza on irc.libera.chat]
irc.libera.chat][irc] and a [Telegram chat][tg] for discussions and and a [Telegram chat] for discussions and development. You can also sponsor the
development. You can also sponsor the maintainer of Mycorrhiza, maintainer of Mycorrhiza, [@bouncepaw], on [Boosty]. If you want to contribute
[@bouncepaw][bp], on [Boosty][bp-donate]. If you want to contribute with code, with code, you can either open a pull request on GitHub or send a patch to the
you can either open a pull request on GitHub or send a patch to the [mailing [mailing list]. Feel free to open an issue on GitHub or contact us directly.
list][mlist]. Feel free to open an issue on GitHub or contact us directly.
You can view the list of planned features at [our GitHub project kanban You can view the list of planned features at [our GitHub project kanban
board][kanban] or on the [roadmap page][roadmap]. board][kanban] or on the [roadmap page].
[hypha]: https://mycorrhiza.wiki/hypha/feature/hypha
[transclusion]: https://mycorrhiza.wiki/hypha/feature/transclusion
[authorization]: https://mycorrhiza.wiki/hypha/feature/authorization
[Mycomarkup]: https://mycorrhiza.wiki/help/en/mycomarkup
[Git]: https://mycorrhiza.wiki/hypha/integration/git
[Opengraph]: https://mycorrhiza.wiki/hypha/standard/opengraph
[Telegram]: https://mycorrhiza.wiki/help/en/telegram
[feature-hypha]: https://mycorrhiza.wiki/hypha/feature/hypha [#mycorrhiza on irc.libera.chat]: irc://irc.libera.chat/#mycorrhiza
[feature-transclusion]: https://mycorrhiza.wiki/hypha/feature/transclusion [Telegram chat]: https://t.me/mycorrhizadev
[feature-authorization]: https://mycorrhiza.wiki/hypha/feature/authorization [@bouncepaw]: https://github.com/bouncepaw
[mycomarkup]: https://mycorrhiza.wiki/help/en/mycomarkup [Boosty]: https://boosty.to/bouncepaw
[integration-git]: https://mycorrhiza.wiki/hypha/integration/git [mailing list]: https://lists.sr.ht/~handlerug/mycorrhiza-devel
[standard-og]: https://mycorrhiza.wiki/hypha/standard/opengraph
[telegram]: https://mycorrhiza.wiki/help/en/telegram
[irc]: irc://irc.libera.chat/#mycorrhiza
[tg]: https://t.me/mycorrhizadev
[bp]: https://github.com/bouncepaw
[bp-donate]: https://boosty.to/bouncepaw
[mlist]: https://lists.sr.ht/~handlerug/mycorrhiza-devel
[kanban]: https://github.com/bouncepaw/mycorrhiza/projects/1 [kanban]: https://github.com/bouncepaw/mycorrhiza/projects/1
[roadmap]: https://mycorrhiza.wiki/hypha/release/roadmap [roadmap page]: https://mycorrhiza.wiki/hypha/release/roadmap