1
0
mirror of https://github.com/osmarks/mycorrhiza.git synced 2024-10-30 03:36:16 +00:00
mycorrhiza/README.md

46 lines
2.5 KiB
Markdown
Raw Normal View History

2021-07-01 18:52:59 +00:00
# 🍄 Mycorrhiza Wiki
2021-11-10 11:43:20 +00:00
2021-10-27 06:54:29 +00:00
**Mycorrhiza Wiki** is a lightweight file-system wiki engine that uses Git for keeping history. [Main wiki](https://mycorrhiza.wiki)
2022-04-01 18:27:45 +00:00
<img src="https://mycorrhiza.wiki/binary/release/1.9/screenshot" alt="A screenshot of mycorrhiza.wiki's home page in the Safari browser" width="700">
2021-08-11 05:41:53 +00:00
2022-02-23 16:18:32 +00:00
2020-10-03 17:05:10 +00:00
## Features
2020-07-19 15:00:44 +00:00
2021-08-11 05:41:53 +00:00
* **No database required.** Everything is stored in plain files. It makes installation super easy, and you can modify the content directly by yourself.
2022-04-03 10:58:48 +00:00
* **Everything is hyphae.** A hypha is a unit of content such as a picture, video or a text article. Hyphae can [transclude] and link each other, forming a tight network of hypertext pages.
2021-11-10 11:43:20 +00:00
* **Hyphae are authored in [Mycomarkup],** a markup language that's designed to be unambigious yet easy to use.
* **Categories** let you organize hyphae without any hierarchy restrictions, with all the benefits of a category system.
2022-04-03 10:58:48 +00:00
* **Nesting of hyphae** is also supported if you like hierarchies.
* **History of changes** for textual parts of hyphae. Every change is safely stored in [Git]. Web feeds for recent changes included.
2021-07-01 18:52:59 +00:00
* **Keyboard-driven navigation.** Press `?` to see the list of shortcuts.
2022-04-03 10:58:48 +00:00
* **Support for [authorization].** Both plain username-password pairs and [Telegram]'s login widget are supported.
* **[Open Graph] support.** The most relevant info about a hypha is made available through OG meta tags for consumption by other software.
2021-07-01 18:52:59 +00:00
2022-04-03 10:58:48 +00:00
[transclude]: https://mycorrhiza.wiki/hypha/feature/transclusion
2022-02-23 16:18:32 +00:00
[Mycomarkup]: https://mycorrhiza.wiki/help/en/mycomarkup
[Git]: https://mycorrhiza.wiki/hypha/integration/git
2022-04-03 10:58:48 +00:00
[authorization]: https://mycorrhiza.wiki/hypha/feature/authorization
2022-02-23 16:18:32 +00:00
[Telegram]: https://mycorrhiza.wiki/help/en/telegram
2022-04-03 10:58:48 +00:00
[Open Graph]: https://mycorrhiza.wiki/hypha/opengraph
2022-02-23 16:18:32 +00:00
2021-08-11 05:41:53 +00:00
Compare Mycorrhiza Wiki with other engines on [WikiMatrix](https://www.wikimatrix.org/show/mycorrhiza).
2022-02-23 16:18:32 +00:00
## Installing
2021-08-12 14:09:26 +00:00
See [the deployment guide](https://mycorrhiza.wiki/hypha/guide/deployment) on the wiki.
2022-02-23 16:18:32 +00:00
2021-07-01 18:52:59 +00:00
## Contributing
* [SourceHut](https://sr.ht/~bouncepaw/mycorrhiza)
2022-04-03 10:58:48 +00:00
* [GitHub](https://github.com/bouncepaw/mycorrhiza)
2022-02-23 16:18:32 +00:00
* [#mycorrhiza on irc.libera.chat](irc://irc.libera.chat/#mycorrhiza)
* [@mycorrhizadev (Russian) in Telegram](https://t.me/mycorrhizadev)
2022-04-03 10:58:48 +00:00
If you want to contribute with code, open a pull request on GitHub or send a patch to the [mailing list](https://lists.sr.ht/~bouncepaw/mycorrhiza-devel).
If you want to report an issue, open an issue on GitHub or contact us directly.
2021-11-10 11:43:20 +00:00
2022-02-23 16:18:32 +00:00
Consider supporting the development on [Boosty](https://boosty.to/bouncepaw).