Giter Club home page Giter Club logo

qilin-app's Introduction

Qilin Editor

Greenkeeper badge Build Status License Github Releases

Qilin is a free, open-source and fully hackable text editor developed for exact sciences in mind. It fully supports KaTeX and AsciiMath. Qilin works on each desktop platform - it is based on Chromium and Node.js, licensed under the MIT license. Qilin is extensible via several plugins and themes. Created documents can be exported as HTML, PDF and Markdown.

Qilin editor

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) am not able to provide regular updates, so any help is more than welcome.

Contributing

Bug reporting

Github Open Issues Github Closed Issues Github Pull Requests

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 - they are being tracked on GitHub Issues.

License

Qilin was created and developed by Bartosz Łaniewski. The full list of contributors can be found here. Qilin's code is MIT licensed. We also provide an additional "patent" grant.

Installation

There are two ways to install Qilin. Please, refer to INSTALL.md file for more instructions. If you wonder how to use Qilin or have any other questions - check our 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. You will need a local copy of Node.js installed on your machine.

$ npm install

Usage

$ npm run <command>

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. You can find some devblogs on my Youtube channel.

Qilin light mode Qilin dark mode

qilin-app's People

Contributors

bartozzz avatar greenkeeper[bot] avatar kazigk avatar jakubserwatka avatar kinnerapriyap avatar alufers avatar

Watchers

James Cloos avatar 周波 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.