Skip to content

Commit

Permalink
Update documents (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
taggon authored Jul 13, 2017
1 parent 659eb22 commit e735c89
Show file tree
Hide file tree
Showing 2 changed files with 109 additions and 11 deletions.
64 changes: 53 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,58 @@
# Highlight for mac
<p align="center">
<img src="https://user-images.githubusercontent.com/212034/28132290-577374c6-6777-11e7-9dd2-802606985c2b.png" width="256" height="256">
</p>

Easily convert copied plain code into syntax highlighted one.
[[English](https://github.com/taggon/highlight/blob/master/README.md)]
[[한국어](https://github.com/taggon/highlight/blob/master/docs/README.ko.md)]

## How to use
# Highlight

1. Run the application.
2. Copy any text code.
![](https://cloud.githubusercontent.com/assets/212034/24546063/a94b57c0-1644-11e7-9eb7-47e5d1c6526c.png)
Highlight is a rich-featured syntax highlighter for Keynote slides that allows you to get syntax-highlighted code in RTF with one click.
Its main feature is based on [highlight.js](https://highlightjs.org/), which means 176 langauges and 79 styles are available.
Check out the [demo](https://highlightjs.org/static/demo/) to see what you get with the application.

3. Select this application in the menu bar and Click Highlight Code.
![](https://cloud.githubusercontent.com/assets/212034/24546095/c523e278-1644-11e7-80ab-3637c369ae4a.png)
## Features

4. Paste it anywhere that accepts rich text.
5. Tada!
![](https://cloud.githubusercontent.com/assets/212034/24546179/03231210-1645-11e7-8ec8-6ab11600dfd6.png)
From highlight.js:

* 176 languages and 79 styles
* Automatic language detection
* Multi-language code highlighting

Original featuers:

* Line numbers
* Custom font
* Global hotkey - you don't even need to click.
* Automatic updates
* Supports English and Korean - any constributions are appreciated. :)

## Installation

* Download the latest version [here](https://github.com/taggon/highlight/releases).
* Unarchive it and then run the application.
* You may be asked to move it into Applications folder. I strongly recommend accepting it.

## Usage

![](https://user-images.githubusercontent.com/212034/28166880-98238d06-6814-11e7-9418-83a286a8a67d.gif)

* When you execute the application, you will see a highlighter icon on the menubar as shown in the screenshot.
![](https://user-images.githubusercontent.com/212034/28166990-f05c99fe-6814-11e7-9ec8-c7569a20763d.png)
* Copy any code you want to colorize.
* Click on the icon to open the popup menu. Select Highlight Code and then pick your programming language
or just choose the auto-detect one. Now the code is syntax-highligted.
* Paste the code wherever you want (e.g. Keynote).

Want to customize results? Open the Preferences dialog.

## Contribution

Highlight supports multi-language UI, currently only for English and Korean.
If you're interested in translating the application, start by copying
[the Korean translation folder](https://github.com/taggon/highlight/tree/master/Highlight/ko.lproj) into your respective language folder
(e.g. pr.lproj for Portuguese, ru.lproj for Russian, etc).

You need to translate all files in the folder except [MoveApplication.strings](https://github.com/taggon/highlight/blob/master/Highlight/ko.lproj/MoveApplication.strings)
that comes from [LetsMove](https://github.com/potionfactory/LetsMove) project.
I will copy the file for your language from the project as soon as your translation is merged into the master branch.
56 changes: 56 additions & 0 deletions docs/README.ko.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<p align="center">
<img src="https://user-images.githubusercontent.com/212034/28132290-577374c6-6777-11e7-9dd2-802606985c2b.png" width="256" height="256">
</p>

[[English](https://github.com/taggon/highlight/blob/master/README.md)]
[[한국어](https://github.com/taggon/highlight/blob/master/docs/README.ko.md)]

# Highlight

Highlight는 클릭 한 번으로 키노트 슬라이드에 문법이 강조되어 색상이 입혀진 RTF 형식의 코드를 붙여넣을 수 있으며, 다양한 기능을 갖춘 문법 강조 프로그램입니다.
주요 기능은 [highlight.js](https://highlightjs.org/)를 기반으로 하고 있으므로, 마찬가지로 176개의 언어와 79개의 스타일을 지원합니다.
이 애플리케이션을 사용했을 때 코드가 어떻게 표현되는지 궁금한 분은 [데모](https://highlightjs.org/static/demo/)를 확인해보시기 바랍니다.

## 기능

highlight.js의 기능:

* 176개 언어와 79개 스타일
* 언어 자동 감지
* 다중 언어 코드 문법 강조

고유 기능:

* 줄 번호
* 커스텀 폰트
* 전역 단축키 - 클릭조차 필요없습니다.
* 자동 업데이트
* 영어와 한국어 UI 지원 - 다른 언어 번역도 환영합니다. :)

## 설치

* [여기](https://github.com/taggon/highlight/releases)에서 최신 버전을 다운로드 받습니다.
* 압축을 해제하고 애플리케이션을 실행합니다.
* 응용프로그램 폴더로 프로그램을 이동하라는 요청이 있을 수 있습니다. 원활한 이용을 위해 가능하면 허용할 것을 권장합니다.

## 사용법

![](https://user-images.githubusercontent.com/212034/28166880-98238d06-6814-11e7-9418-83a286a8a67d.gif)

* 애플리케이션을 실행하면 아래 스크린샷처럼 형광펜 아이콘이 나타납니다.
![](https://user-images.githubusercontent.com/212034/28166990-f05c99fe-6814-11e7-9ec8-c7569a20763d.png)
* 구문 강조 색상을 입힐 코드를 복사합니다.
* 메뉴바에서 아이콘을 클릭해 팝업 메뉴를 엽니다. 구문 강조 후 복사 메뉴에서 프로그래밍 언어를 고르거나 구문강조 후 복사(언어 자동 감지)를 클릭합니다. 이제 코드에 구문강조 색상이 입혀졌을 것입니다.
* 원하는 곳(예. 키노트)에 코드를 붙여넣습니다.

더 자세하게 결과물을 조절하고 싶다면? 환경설정 대화상자를 살펴보시기 바랍니다.

## 기여 방법

Highlight는 다국어 UI를 지원하는데 현재는 영어와 한국어를 지원합니다.
이 애플리케이션을 번역하고 싶다면 먼저
[한국어 번역 폴더](https://github.com/taggon/highlight/tree/master/Highlight/ko.lproj)를 원하는 언어
(예. 포르투갈어라면 pr.lproj, 러시아어라면 ru.lproj 등)에 해당하는 폴더로 복사하세요.

폴더 안에 있는 파일은 [LetsMove](https://github.com/potionfactory/LetsMove) 프로젝트에서 가져 온 [MoveApplication.strings](https://github.com/taggon/highlight/blob/master/Highlight/ko.lproj/MoveApplication.strings)를 제외하고는 모두 번역해야 합니다.
작성한 언어가 마스터 브랜치에 병합되고 나면 그 언어에 해당하는 파일을 LetsMove 프로젝트로부터 제가 직접 복사할 것입니다.

0 comments on commit e735c89

Please sign in to comment.