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:
bouncepaw 2020-12-08 20:26:18 +05:00
parent 8810e9891d
commit 37eb3d1c77
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -28,6 +28,8 @@ Options:
Port to serve the wiki at (default "1737") Port to serve the wiki at (default "1737")
-title string -title string
How to call your wiki in the navititle (default "🍄") How to call your wiki in the navititle (default "🍄")
-url string
URL at which your wiki can be found. Used to generate feeds (default "http://0.0.0.0:$port")
-user-tree string -user-tree string
Hypha which is a superhypha of all user pages (default "u") Hypha which is a superhypha of all user pages (default "u")
``` ```
@ -37,16 +39,16 @@ Options:
* Responsive design * Responsive design
* Works in text browsers * Works in text browsers
* Wiki pages (called hyphae) are written in mycomarkup * 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. * 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 * Page trees; links to previous and next pages
* Changes are saved to git * Changes are saved to git
* List of hyphae page * List of hyphae page
* History page * History page
* Random page * Random page
* Recent changes page * Recent changes page; RSS, Atom and JSON feeds available
* Hyphae can be deleted (while still preserving history) * Hyphae can be deleted (while still preserving history)
* Hyphae can be renamed (recursive renaming of subhyphae is also supported) * 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](http://www.orangepi.org/orangepilite/). * Light on resources: I run a home wiki on this engine 24/7 at an [Orange π Lite](http://www.orangepi.org/orangepilite/)
* Authorization with pre-set credentials * Authorization with pre-set credentials
## Contributing ## Contributing