bfb9ba6269
Updated Readme.
Can't delete about page.
Former-commit-id: be56199188297de59661de64c5a27df2d6ff2294 [formerly bc94386b7ab3bb595a593c9c6503cce100d68c2e] [formerly fa563c59100d6fc9e1a2cc526545a8bf546d4581 [formerly dfe00ad570]]
Former-commit-id: 34af2ded11e5a731f5cdfce08c28d63cb014fef6 [formerly 12d756d80140e1e23aa48146eec2ee0db138af69]
Former-commit-id: 3e9a447113e0c46975808ff7b93a82ba9c917e07
2.8 KiB
AwwKoala
A Websocket Wiki and Kind Of A List Application
This is a self-contained wiki webserver that makes sharing easy and fast. You can make any page you want, and any page is editable by anyone. Pages load instantly for editing, and have special rendering for whether you want to view as a web page or view as list. AwwKoala is also Open Source.
Features
Simplicity. The philosophy here is to just type. To jot a note, simply load the page at / and just start typing. No need to press edit, the browser will already be focused on the text. No need to press save - it will automatically save when you stop writing. The URL at / will redirect to an easy-to-remember name that you can use to reload the page at anytime, anywhere. But, you can also use any URL you want, e.g. /AnythingYouWant.
Viewing. All pages can be rendered into HTML by adding /view. For example, the page /AnythingYouWant is rendered at /AnythingYouWant/view. You can write in HTML or Markdown for page rendering. To quickly link to /view pages, just use [[AnythingYouWant]]. Math is supported with Katex using $\frac{1}{2}$ for inline equations and $$\frac{1}{2}$$ for regular equations.
Listifying. If you are writing a list and you want to tick off things really easily, just add /list. For example, after editing /grocery, goto /grocery/list. In this page, whatever you click on will be struck through and moved to the end. This is helpful if you write a grocery list and then want to easily delete things from it.
Security. HTTPS support is provided and everything is sanitized to prevent XSS attacks. Though all URLs are publicly accessible, you are free to obfuscate your website by using an obscure/random address (read: the site is still publicly accessible, just hard to find!). The automatic URL is an alliterative animal description - of which there are over 500,000 possibilities - so the URL is easy to remember and hard to guess.
Keyboard Shortcuts. Quickly transition between Edit/View/List by using Ctl+Shift+E to Edit, Ctl+Shift+Z to View, and Ctl+Shift+L to Listify.
Contact
Any other comments, questions or anything at all, just tweet me @zack_118
Have fun.
Powered by Raspberry Pi, Go, and NGINX
