mirror of
https://github.com/schollz/cowyo.git
synced 2023-08-10 21:13:00 +03:00
c542615b62
information Former-commit-id: 9afef25b0304da842eb41cde6613ee2a56b14ef7 [formerly 2d26b64ed0752e3e1276fa8bf89c8d986b3837cf] [formerly 8785846c8b218b30b18451c2b46387cc505ca85b [formerly c382f978c2e794f2add70d2e89d574d072578a0c [formerlyaf04d05233]]] Former-commit-id: 6e344f746285c5dbf984758f4373ebd5f0073bc5 [formerly 37fe3ff0c5c8287ca2acddde853b4424c17845bd] Former-commit-id: ba1c83d4af161836f8ea13357dbf383d9b6105a8 Former-commit-id:7eb62c03ee
30 lines
3.1 KiB
Markdown
30 lines
3.1 KiB
Markdown
|
|
|
|
# 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](https://github.com/schollz/AwwKoala).
|
|
|
|
## 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`](/AnythingYouWant).
|
|
|
|
**Viewing**. All pages can be rendered into HTML by adding `/view`. For example, the page [`/AnythingYouWant`](/AnythingYouWant) is rendered at [`/AnythingYouWant/view`](/AnythingYouWant/view). You can write in HTML or [Markdown](https://daringfireball.net/projects/markdown/) for page rendering. To quickly link to `/view` pages, just use `[[AnythingYouWant]]`. Math is supported with [Katex](https://github.com/Khan/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`](/grocery), goto [`/grocery/list`](/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.
|
|
|
|
**Self-destructing messages**. You can write a message that will delete itself when a user loads it (in any view). Useful for transmitting sensitive information. To use, simply add a line somewhere that says only "`self-destruct`".
|
|
|
|
# Contact
|
|
Any other comments, questions or anything at all, just <a href="https://twitter.com/intent/tweet?screen_name=zack_118" class="twitter-mention-button" data-related="zack_118">tweet me @zack_118</a>
|
|
|
|
Have fun.
|
|
|
|
**Powered by Raspberry Pi, Go, and NGINX**
|
|
|
|
  
|