jianmin-chen / eloquent

Eloquent is a Typora theme designed for writing technical books. It's minimal and easy to use!
MIT License
12 stars 1 forks source link

Eloquent

About

Eloquent is a Typora theme designed for writing technical books. It's minimal and easy to use!

Thumbnail

Eloquent was created and tested on Linux, but it hasn't been tested in macOS or Windows yet.

Installation

Install Typora on your operating system using the instructions here, and then download the latest release of this theme here, which should be a ZIP file named as eloquent.zip. Extract this folder to Typora's theme folder, which can be found by opening Typora and going to File > Preferences > Appearance. Once you have the ZIP extracted, simply go into the folder containing the theme(i.e, eloquent), and pull out eloquent.css into the parent directory. Open Typora again, and you should be able to change the theme to Eloquent.

Usage

Once you have the theme running, simply start writing in Markdown! A good starter guide to Markdown can be found here.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jianmin-chen/eloquent. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The theme is available as open source under the terms of the MIT License.