Qilin Editor
[](https://greenkeeper.io/)
[](https://travis-ci.org/qilin-editor/qilin-app/)
[](LICENSE)
[](https://github.com/qilin-editor/qilin-app/releases)
**Qilin** is a *free*, *open-source* and *fully hackable* text editor developed for exact sciences in mind. It fully supports [`KaTeX`](https://khan.github.io/KaTeX/) and [`AsciiMath`](http://asciimath.org/). Qilin works on each desktop platform - it is based on `Chromium` and `Node.js`, licensed under the *[MIT license](#license)*. Qilin is extensible via several [plugins and themes](https://github.com/qilin-editor/qilin-manager). Created documents can be exported as **HTML**, **PDF** and **Markdown**.
>**Note**: Qilin Editor and all related repositories are still in development - it might not be suitable for daily, intensive usage. As the only active maintainer, I ([@Bartozzz](https://github.com/Bartozzz)) am not able to provide regular updates, so any help is more than welcome.
Contributing
### Bug reporting
[](https://github.com/qilin-editor/qilin-app/issues)
[](https://github.com/qilin-editor/qilin-app/issues?q=is%3Aissue+is%3Aclosed)
[](https://github.com/qilin-editor/qilin-app/pulls)
**We want contributing to Qilin to be fun, enjoyable, and educational for everyone.** Changes and improvements are more than welcome! Feel free to fork and open a pull request. If you have found any issues, please [report them here](https://github.com/qilin-editor/qilin-app/issues/new) - they are being tracked on [GitHub Issues](https://github.com/qilin-editor/qilin-app/issues).
### License
Qilin was created and developed by [Bartosz Łaniewski](https://github.com/Bartozzz). The full list of contributors can be found [here](https://github.com/qilin-editor/qilin-app/graphs/contributors). Qilin's code is [MIT licensed](https://github.com/qilin-editor/qilin-app/blob/master/LICENSE). We also provide an additional ["patent" grant](https://github.com/qilin-editor/qilin-app/blob/master/PATENTS).
### Installation
There are two ways to install Qilin. Please, refer to [INSTALL.md](INSTALL.md) file for more instructions. If you wonder how to use Qilin or have any other questions - check our [Wiki](https://github.com/qilin-editor/qilin-app/wiki).
### Development
We have prepared multiple commands to help you develop Qilin on your own. Don't forget to install all `Node.js` dependencies from [npm](https://www.npmjs.com/). You will need a local copy of [Node.js](https://nodejs.org/en/) installed on your machine.
```bash
$ npm install
```
#### Usage
```bash
$ npm run
```
#### List of commands
| Command | Description |
|---------------|---------------------------------------------------|
| `preapre-qpm` | Prepares Qilin package manager |
| `preapre` | Prepares Qilin itself |
| `build` | Builds Qilin binaries for macOS, Windows, Linux |
| `start` | Builds and opens Qilin application |
| `watch` | Builds on changes and opens Qilin application |
| `clean` | Deletes cache directories |
| `eslint` | Fixes ESLinter errors |
| `stylelint` | Fixes StyleLint errors |
| `nw` | Opens Qilin application |
Screenshots
All the screenshots can be found on [Imgur](http://imgur.com/a/CVOFC). You can find some devblogs on my [Youtube channel](https://www.youtube.com/playlist?list=PLK2Lb6JZ41iOvtBN4H5GLELHYJDOVZTGN).
