Mimir is a small, opinionated Markdown wiki, knowledge base, or digital garden written in Go. It is named after the Norse mythological figure Mímir, who seemed like a nice dude and knew a lot of things.
Mimir has the following features:
[[Double Brackets]]. A link like this would lead to the page
Mimir is built entirely around the things that I want from a wiki engine, but I am very open to ideas for new features and improvements on current ones, and will be delighted if anyone finds it useful!
Mimir requires Go to be installed.
Mimir requires an directory to create its wiki documents, and a
config.toml file. These do not have to be in the same directory, but can be:
mkdir ~/wiki touch ~/wiki/config.toml
config.toml looks like this:
site_title = "Mimir" # If true, viewing will be restricted to signed in users with can_view = true. # If false, any visitor can view the wiki. restrict_viewing = true # If true, editing and diff viewing will be restricted to signed in users with can_edit = true. # If false, any visitor can edit and view page diffs. restrict_editing = true show_backlinks = true # The media upload directory will be the /media subdirectory in your base wiki directory. media_directory = "media" # This user, 'admin', can both view and edit pages. [[users]] username = "admin" password = "admin" can_view = true can_edit = true # The user 'user' can only view pages. [[users]] username = "user" password = "user" can_view = true can_edit = false
Clone this repository and run the program:
go run . --dir ~/wiki --config ~/wiki/config.toml
Alternatively, build the binary, then run it from somewhere on your
go build . mv mimir /usr/local/bin mimir --dir ~/wiki --config ~/wiki/config.toml
The default theme for Mimir is intentionally bare-bones (some would say 'hideous'). If your wiki directory is
~/wiki and the
theme = "themename" property is specified in
config.toml, Mimir will attempt to load the file
~/wiki/themes/themename.css after the basic styles. An example nicer theme is provided in this repository under