mirror of
https://github.com/schollz/cowyo.git
synced 2023-08-10 21:13:00 +03:00
78 lines
2.0 KiB
Markdown
78 lines
2.0 KiB
Markdown
|
|
<p align="center">
|
|
<img
|
|
src="/static/img/logo.png"
|
|
width="260" height="80" border="0" alt="linkcrawler">
|
|
<br>
|
|
<a href="https://travis-ci.org/schollz/cowyo"><img src="https://img.shields.io/travis/schollz/cowyo.svg?style=flat-square" alt="Build Status"></a>
|
|
<img src="https://img.shields.io/badge/version-2.0.6-brightgreen.svg?style=flat-square" alt="Version">
|
|
</p>
|
|
|
|
<p align="center">A feature-rich wiki for minimalists</a></p>
|
|
|
|
*cowyo* is a self-contained wiki server that makes jotting notes easy and _fast_. The most important feature here is _simplicity_. Other features include versioning, page locking, self-destructing messages, encryption, and listifying. You can [download *cowyo* as a single executable](https://github.com/schollz/cowyo/releases/latest) or install it with Go. Try it out at https://cowyo.com.
|
|
|
|
Getting Started
|
|
===============
|
|
|
|
## Install
|
|
|
|
If you have go
|
|
|
|
```
|
|
go get github.com/schollz/cowyo
|
|
```
|
|
|
|
or just download from the [latest releases](https://github.com/schollz/cowyo/releases/latest).
|
|
|
|
## Run
|
|
|
|
To run just double click or from the command line:
|
|
|
|
```
|
|
cowyo
|
|
```
|
|
|
|
## Usage
|
|
|
|
*cowyo* is straightforward to use. Here are some of the basic features:
|
|
|
|
### Editing
|
|
|
|
When you open a document you'll be directed to an alliterative animal (which is supposed to be easy to remember). You can write in Markdown. Saving is performed as soon as you stop writing.
|
|
|
|
|
|
|
|
### History
|
|
|
|
You can easily see previous versions of your documents.
|
|
|
|
|
|
|
|
### Lists
|
|
|
|
You can easily make lists and check them off.
|
|
|
|
|
|
|
|
### Locking
|
|
|
|
Locking prevents other users from editing your pages without a passphrase.
|
|
|
|
|
|
|
|
### Encryption
|
|
|
|
Encryption is performed using AES-256.
|
|
|
|
|
|
|
|
### Self-destructing pages
|
|
|
|
Just like in mission impossible.
|
|
|
|
|
|
|
|
## License
|
|
|
|
MIT |