Skip to content

Latest commit

 

History

History
74 lines (53 loc) · 4.56 KB

README.md

File metadata and controls

74 lines (53 loc) · 4.56 KB

TightWiki

For years I’ve worked at places where we just needed a simple to use, searchable, unobtrusive, no-nonsense, collaborative and free place to dump documentation. The first thing that comes to mind is a Wiki but for some reason I can never find anything that "checks all the boxes". Hopefully you'll find this one does for you.

😋 TightWiki is an ASP.NET Core MVC Razor WIKI written in C# that sits on top of a SQLite database (zero configuration required).

🤞 Play with the latest dev build at http://TightWiki.com/. If you want to edit, you can signup using google auth or native TightWiki login.

👀 Or check out the full wiki documentation to learn about the engine functionality.

⭐ Ready to run it for yourself? Check out the installation instructions!

💥 Also be sure to check out the screenshots below the feature list...

😧 Its been like a modern retelling of Sisyphus, only this time the stone is RegEx.

😲 Features (some of them anyway)

  • MIT license, you can use it for free at home or at your business.
  • Open source, you can make changes, submit fixes or just make suggestions.
  • Completely customizable and rebrandable including name, title, footer, copyright and all images.
  • User signup can be disabled, enabled and can require users to verify email before logging in.
  • Multiple user roles are supported for admin, moderators, contributors and basic members.
  • Easy page linking. Can even link to pages that do not exist and the link will subtly prompt you to create the page when logged in with a role that has page creation support.
  • Admin shows missing pages, namespace metrics, users, roles, etc.
  • Manual account creation, editing and deletion.
  • All dates/times are stored in UTC and localized for logged in users.
  • Admin moderation which is driven by page processing instructions for things like page deletions, review, drafts, etc.
  • Page versioning. Revisions can be viewed by the original page URL with a /r/number route or by logging in a viewing the full page history.
  • Revertible page history.
  • Theme-able, with 25+ built in themes.
  • Drag-drop fie uploads / page attachments, images.
  • Versioned file uploads.
  • Namespace support so you can have multiple pages with the same name in different namespaces.
  • Fully baked in documentation of all wiki functions.
  • Wiki Markup allows you post non-formatted code and even auto-syntax highlighting for things like C#, PHP, SQL, etc. Can also explicitly specify language.
  • Wiki markup supports basic formatting, headings and sub-headings, tagging, tables, callouts, alerts, variables, bullets lists, dynamic glossaries, inline search results, dynamic tag clouds, related linking, expanding sections, auto-table of contents, and much more.
  • Wiki page editing is syntax highlighted.
  • Built in search supports fuzzy matching to support even mild misspellings.

Default home page

image

Site Metrics

We've beat the wiki up with more data than this, but this is our standard workload. ~45,000 pages, in ~400 namespaces, with ~250,000 revisions, created by ~1,000 users, manifesting ~5 million search tokens. The random fuzzy-match search time is 11 milliseconds. Not too shabby, right?

image

Page search

Clip9

Page History

Clip2

Example edit page

Clip1

Build in documentation list

Clip7

Build in documentation sample

Clip8

Configuration

Clip3

Admin page list

Clip6

Admin role list

Clip4

Its been like a modern retelling of Sisyphus, only this time with RegEx.