mirror of
https://github.com/schollz/cowyo.git
synced 2023-08-10 21:13:00 +03:00
6bb6d20b06
Former-commit-id: 95259b4e6ad41b09c66ddc18a9222e9012d95da5 [formerly 0bf8f37889240273213fedb8b1c4adea1d03d35a] [formerly 7a5b2b0611c493453d4779ea292e69b75698d7e7 [formerly f61b60b9c2
]]
Former-commit-id: e87b385ea0205f264a0ece0d41e4ce29f26c956a [formerly 0fa30f3102ac182739a67ad51c78328c6cf67165]
Former-commit-id: 3dfb3add8fc059fc710bf60aea327b23687e56ff
21 lines
2.0 KiB
Markdown
21 lines
2.0 KiB
Markdown
![Logo](https://i.imgur.com/ixnBYOl.png)
|
|
|
|
# AwwKoala
|
|
## A Websocket Wiki and Kind Of A List Application
|
|
![Version 1.0](https://img.shields.io/badge/version-1.0-brightgreen.svg)
|
|
|
|
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. 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).
|