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
Wiki engine fork.
209 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%
c726a8b307
Go to file
bouncepaw c726a8b307 Fix the error when previewing
2021-02-20 21:21:10 +05:00
history Fix revision contents not showing 2021-02-20 21:17:20 +05:00
hyphae Split module hyphae into two modules 2021-02-20 19:03:54 +05:00
link Strip extra whitespace from links 2021-02-06 21:16:21 +05:00
markup Find backlinks on wiki start 2021-02-19 14:23:57 +05:00
metarrhiza@e7040f3e0d Add proof-of-concept Gemini output of /hypha/ 2021-02-09 19:35:02 +05:00
mimetype Move mimetype stuff to a separate module 2021-01-29 00:07:21 +05:00
shroom Move navititle, attachment block, backlinks sidebar to the new views module 2021-02-20 20:48:51 +05:00
templates Move readers views to the views module 2021-02-20 21:14:33 +05:00
tree Move subhyphae to the bottom 2021-02-19 23:12:36 +05:00
user Add /admin/shutdown 2021-02-18 19:50:37 +05:00
util Start the Great Refactoring 2021-02-17 23:41:35 +05:00
views Move readers views to the views module 2021-02-20 21:14:33 +05:00
.gitignore Move mimetype stuff to a separate module 2021-01-29 00:07:21 +05:00
.gitmodules Replace with 0.7 version in a primitive way 2020-08-05 20:08:59 +05:00
flag.go Start the Great Refactoring 2021-02-17 23:41:35 +05:00
gemini.go Start the Great Refactoring 2021-02-17 23:41:35 +05:00
go.mod Add proof-of-concept Gemini output of /hypha/ 2021-02-09 19:35:02 +05:00
go.sum Add proof-of-concept Gemini output of /hypha/ 2021-02-09 19:35:02 +05:00
http_admin.go Implement the admin panel and fix a bug with /reindex 2021-02-18 20:16:15 +05:00
http_auth.go Start the Great Refactoring 2021-02-17 23:41:35 +05:00
http_history.go Move readers views to the views module 2021-02-20 21:14:33 +05:00
http_mutators.go Fix the error when previewing 2021-02-20 21:21:10 +05:00
http_readers.go Move readers views to the views module 2021-02-20 21:14:33 +05:00
LICENSE Create LICENSE 2020-11-24 22:46:18 +05:00
main.go Move navititle, attachment block, backlinks sidebar to the new views module 2021-02-20 20:48:51 +05:00
Makefile Add proof-of-concept Gemini output of /hypha/ 2021-02-09 19:35:02 +05:00
mycocredentials.json Start implementing fixed authorization system 2020-11-13 23:45:42 +05:00
name.go Move navititle, attachment block, backlinks sidebar to the new views module 2021-02-20 20:48:51 +05:00
README.md Move some files around 2021-01-24 17:52:40 +05:00

README.md

🍄 MycorrhizaWiki 0.13

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.