mirrors/mycorrhiza
1
0
Fork 0
mirror of https://github.com/osmarks/mycorrhiza.git synced 2024-10-30 11:46:16 +00:00
Code Issues Releases Wiki Activity
Wiki engine fork.
175 Commits 1 Branch 0 Tags 13 MiB
Go 70.8%
HTML 13.9%
JavaScript 7.2%
CSS 7.1%
Roff 0.8%
Other 0.2%
2a5d7d580c
Go to file
Timur Ismagilov 2a5d7d580c
Merge pull request #33 from bouncepaw/0.12 
Version 0.12
2021-01-24 13:41:17 +05:00
history Rename -user-tree to -user-hypha 2021-01-23 21:37:29 +05:00
hyphae Drop memdb dependency because it is not used yet 2021-01-24 13:36:03 +05:00
markup Move the protocol icons to the left, change svg icon colors 2021-01-24 13:18:59 +05:00
metarrhiza@be5b922e9b Move the protocol icons to the left, change svg icon colors 2021-01-24 13:18:59 +05:00
templates Move the protocol icons to the left, change svg icon colors 2021-01-24 13:18:59 +05:00
tree Make some visual changes 2021-01-10 18:01:38 +05:00
user Move the user link to the header links 2021-01-24 12:30:14 +05:00
util Move the protocol icons to the left, change svg icon colors 2021-01-24 13:18:59 +05:00
.gitignore Start implementing memdb-driven hyphae 2021-01-03 01:52:23 +05:00
.gitmodules Replace with 0.7 version in a primitive way 2020-08-05 20:08:59 +05:00
flag.go Add header links 2021-01-24 00:00:58 +05:00
go.mod Drop memdb dependency because it is not used yet 2021-01-24 13:36:03 +05:00
go.sum Drop memdb dependency because it is not used yet 2021-01-24 13:36:03 +05:00
http_auth.go Move the user link to the header links 2021-01-24 12:30:14 +05:00
http_history.go Move the user link to the header links 2021-01-24 12:30:14 +05:00
http_mutators.go Move the user link to the header links 2021-01-24 12:30:14 +05:00
http_readers.go Move the user link to the header links 2021-01-24 12:30:14 +05:00
hypha.go Add header links 2021-01-24 00:00:58 +05:00
LICENSE Create LICENSE 2020-11-24 22:46:18 +05:00
main.go Move the user link to the header links 2021-01-24 12:30:14 +05:00
Makefile Implement login form 2020-11-14 15:39:18 +05:00
mime.go Fix wrong mime-type 2020-11-03 00:24:50 +05:00
mycocredentials.json Start implementing fixed authorization system 2020-11-13 23:45:42 +05:00
name.go Add /about page, remove -title option, add -name and -icon options 2021-01-23 18:45:17 +05:00
README.md Add a missing option to the Usage section 2021-01-24 13:40:17 +05:00

README.md

🍄 MycorrhizaWiki 0.12

A wiki engine.

Main wiki

Building

Also see detailed instructions on wiki.

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")
  -header-links-hypha string
        Optional hypha that overrides the header links
  -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, 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

Contributing

Help is always needed. We have a tg chat where some development is coordinated. You can also sponsor on boosty. Feel free to open an issue or contact directly.

You can view list of all planned features on our kanban board.