mirror of
https://github.com/schollz/cowyo.git
synced 2023-08-10 21:13:00 +03:00
4d34638b81
Former-commit-id: 28b93329d92d3d7d01ebdbb42b7d1c20f5fd0518 [formerly a70573f0f01d5151b5288bd289b399e098317c92] [formerly 33bc07777f90f36c3f9829f9e4971a5e3119cc55 [formerly a0c57004a8]]
Former-commit-id: 570e2d901d8732cfc71ffbe95f18a91570e0d00a [formerly 52a740c2799400a2c12dcc1080cb60ca134ba6eb]
Former-commit-id: 7536551aa08126c773bad299754194c8f148adfb
81 lines
4.9 KiB
Markdown
81 lines
4.9 KiB
Markdown
|
|
|
|
# CowYo
|
|
## Collections of Organized Words You Open
|
|
|
|
|
|
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](https://github.com/schollz/cowyo).
|
|
|
|
## 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). 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]]`.
|
|
|
|
|
|
|
|
<br>
|
|
|
|
**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.
|
|
|
|
|
|
|
|
<br>
|
|
|
|
**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.
|
|
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
**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).
|
|
|
|
|
|
|
|
<br>
|
|
|
|
**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`".
|
|
|
|
|
|
|
|
<br>
|
|
|
|
**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_).
|
|
|
|
|
|
|
|
<br>
|
|
|
|
**CLI support**. Want to upload/download from a server? Its super easy. Upload/download files like this:
|
|
```bash
|
|
$ echo "Hello, world!" > hi.txt
|
|
$ curl --upload-file hi.txt cowyo.com
|
|
File uploaded to http://cowyo.com/hi.txt
|
|
$ curl cowyo.com/test.txt
|
|
Hello, world!
|
|
```
|
|
or just skip the file-creation step,
|
|
```bash
|
|
$ echo "Wow, so easy" | curl --upload-file "-" cowyo.com
|
|
File uploaded to http://cowyo.com/CautiousCommonLoon
|
|
$ curl cowyo.com/CautiousCommonLoon
|
|
Wow, so easy
|
|
```
|
|
|
|
<br>
|
|
|
|
**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](https://github.com/Khan/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 <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**
|
|
|
|
  
|