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
9316e671b6
mycorrhiza/README.md
bouncepaw 84545dd9f1 Rename -user-tree to -user-hypha
2021-01-23 21:37:29 +05:00

2.1 KiB
Raw Blame History

🍄 MycorrhizaWiki 0.12

A wiki engine.

Building

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:
  -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")
  -home string
        The home page (default "home")
  -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")
  -port string
        Port to serve the wiki at (default "1737")
  -url string
        URL at which your wiki can be found. Used to generate feeds (default "http://0.0.0.0:$port")
  -user-hypha string
        Hypha which is a superhypha of all user pages (default "u")

Features

  • Edit pages through html forms
  • Responsive design
  • 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: I run a home wiki on this engine 24/7 at an Orange π Lite
  • Authorization with pre-set credentials

Contributing

Help is always needed. We have a tg chat where some development is coordinated. Feel free to open an issue or contact me.

Future plans

  • Tagging system
  • Better history viewing