# rikidown

A Rust-based wiki with markdown.

Simply write your wiki pages in Markdown, commit to a git repo and push.
rikidown will refresh its git repo, then render your markdown pages inside of a template.

## How does it work

GET /README.md HTTP/1.1

When rikidown recieves a GET request for a markdown page, it renders it using markdown-rs.

rikidown uses rouille to start the http server, and clap to configure arguments.
The arguments supported include:

- --git-repo the URL of the git repo to load
- --listen address to listen on, in the form of 0.0.0.0:8080
- --obsidian-mode pre-processes markdown files to make them more standard compliant

Additionally, if there is a './template.html' file in the repo, is will be used to wrap
the generated HTML. Specifically, the 'body' block will be replaced by the markdown content.

## Obsidian mode

Intended to create compatibility with Obsidian, because it has a fancy UI.
Specifically, this replaces `[[thing]]` with `[thing](thing.md)`
None of the other options in https://help.obsidian.md/obsidian-flavored-markdown are included.

## Future work

Replace the Obisdian markdown with https://crates.io/crates/obsidian-export.