1
0
mirror of https://github.com/schollz/cowyo.git synced 2023-08-10 21:13:00 +03:00
cowyo/templates/aboutpage.md
Zack Scholl 57771c742c Spelling
Former-commit-id: 48f8e7fcd5b4922c54aa222589f19ee383585b5f [formerly 915392153601b2035547b53c4a4d9d143dd5d845] [formerly 6f3b4cddeab74dae3f49253dd3fef55f035f98ab [formerly c610b7397a8bc438a23d142e931779bf9a418193 [formerly db92c60be5]]]
Former-commit-id: 748fefa94f7ced8138f457a6211542be64ada1d4 [formerly c24be73119aa8e41b4e4d663f994dd58fdedda89]
Former-commit-id: 9d6a9698096778fe3ffc4c2d6f4882c750498747
Former-commit-id: fd2af7a85f
2016-03-19 11:33:31 -04:00

4.4 KiB

Logo

CowYo

Collections of Organized Words You Open

Version 0.94

This is a self-contained wiki webserver that makes sharing easy and fast. The most important feature here is simplicity. There are many other features as well including versioning, page locking, self-destructing messages, encryption, math support, and listifying. Read on to learn more about the features. CowYo 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. 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]].

Simply type to edit.


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.

Lists are easy to make.


Page locking. Pages can be locked by providing a password to prevent further editing. The whole version tree will still be available. Note: This is not available for list mode.

Locking is easy.


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).

Versioning is easy.


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".

Mission impossible style self-destruction.


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!). In addition to TLS support, you can PGP-encrypt your messages using a passphrase (Note: This will delete the version tree).

Security and encryption baked in.


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.

Admin controls. The Admin can view/delete all the documents by setting the -a YourAdminKey when starting the program. Then the admin has access to the /ls/YourAdminKey to view and delete any of the pages.

Math support. Math is supported with Katex using $\frac{1}{2}$ for inline equations and $$\frac{1}{2}$$ for regular equations.

Contact

Any other comments, questions or anything at all, just tweet me @zack_118

Have fun.

Powered by Raspberry Pi, Go, and NGINX

Raspberry Pi Go Mascot Nginx