Skip to content

Follpvosten/swiki

Repository files navigation

s(imple )wiki

This is/was a proof-of-concept minimal wiki software built in Rust in about one work week. Mostly intended as a playfield to try out Rocket and sled, but also with a clear goal and that is being fast and minimal in complexity, while offering basic wiki functionality (like MediaWiki, Wiki.js).

Another goal is to also have a simple API so I can easily integrate it with other platforms through chatbots and similar.

I haven't set up any badges yet, but I have near 90% code coverage at the time of writing this README (because whenever I was bored and had nothing else to do, I just went and wrote a bunch of tests).

Since I've abandoned sled now and switched to postgres, I will likely want to at least implement categories before doing a 1.0/MVP release.

Features ToDo

  • Basic password-based registration/login system
    • Simple captchas
  • Articles
    • Creation
    • Editing
    • Renaming
    • Markdown rendering
    • Revision history
    • Deletion
  • Search system (I'm using Tantivy)
  • Admin settings
    • Disabling registration
    • Possibly other management stuff
  • Categories
  • API

A ToDo on the Horizon is also updating the UI; currently I'm using Bulma without any changes, I'd probably like to exclude parts I'm not using and also some custom theming would be nice.

About

Minimal Rust + Markdown wiki

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages