mirror of
https://github.com/schollz/cowyo.git
synced 2023-08-10 21:13:00 +03:00
0f6db92a95
Former-commit-id: a737e4503380c60be58f7737a87cd79944b2ca47 [formerly ad79f72f0f5780255717c0b9c2f6005407a55712] [formerly 643df8a690b674bf9c3972d95097ed9c0330ba81 [formerly 01a91422d9]]
Former-commit-id: 712034514db1c8402f02cc17670425e76af153f1 [formerly b7f903ac993bff3bbb4d7d6ea9a2439cc942e22b]
Former-commit-id: 7f15b334a309663b4ade99ee2b65e3f7b247a698
21 lines
2.1 KiB
Markdown
21 lines
2.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.
|
|
|
|
# Features
|
|
## 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).
|
|
|
|
## Views
|
|
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.
|
|
|
|
## Lists
|
|
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 striked through and moved to the end. This is helpful if you write a grocery list and then want to easily delete things from it.
|
|
|
|
## Automatic versioning
|
|
All previous versions of all notes are stored and can be accessed by adding `?version=X` onto `/view` or `/edit`. If you are on the `/view` or `/edit` pages the menu below will show the most substantial changes in the history. Note, only the _current_ version can be edited (no branching allowed, yet).
|