docs: add Bareun.ai API key instructions

This commit is contained in:
hyungyunlim 2026-05-21 14:58:50 +09:00
parent f3861b56a8
commit ed3eceae2d

View file

@ -32,7 +32,19 @@ The default grammar check uses the app proxy at `appstore.junlim.org`, so no Bar
You can also configure:
- `부산대 맞춤법 검사기` / NaraSpeller: requires a NaraSpeller API key.
- Direct Bareun.ai server: requires your own Bareun.ai host and API key.
- Direct Bareun.ai API/server: requires a Bareun.ai account, API key, and direct API host settings. This is separate from the NaraSpeller/Barun Hangeul service.
## Bareun.ai API Key
Bareun.ai and NaraSpeller have similar Korean names, but they are different services from different providers.
To get a Bareun.ai API key:
1. Open the [Bareun.ai spelling checker page](https://bareun.ai/correct).
2. Sign up or log in to Bareun.ai.
3. Complete email verification if required.
4. Check the API key from Login -> My Info (`로그인` -> `내정보`). The official [Bareun.ai quick-start guide](https://docs.bareun.ai/quick/) describes this as the place where the key is shown after signup and email verification.
5. In Obsidian Settings -> Korean Grammar Assistant -> API Connection (`API 연결`), enter it in `Bareun.ai API 키` only when using a direct Bareun.ai API server. The default proxy does not require this key.
## NaraSpeller API Key
@ -93,7 +105,17 @@ Obsidian 안에서 한국어 맞춤법과 문법을 검사하는 플러그인입
추가로 설정할 수 있는 엔진:
- `부산대 맞춤법 검사기`: 부산대/NaraSpeller API 키 필요.
- 직접 Bareun.ai 서버: 직접 서버 호스트와 Bareun.ai API 키 필요.
- 직접 Bareun.ai 서버: Bareun.ai 계정, API 키, 직접 API 호스트 설정 필요. 부산대/NaraSpeller 키와는 별개입니다.
## Bareun.ai API 키 받기
Bareun.ai와 부산대 맞춤법 검사기(NaraSpeller/바른한글)는 이름이 비슷하지만 서로 다른 서비스입니다.
1. [Bareun.ai 맞춤법 검사기](https://bareun.ai/correct) 페이지를 엽니다.
2. Bareun.ai에 가입하거나 로그인합니다.
3. 필요한 경우 이메일 인증을 완료합니다.
4. Bareun.ai [공식 훑어보기 안내](https://docs.bareun.ai/quick/)처럼 `로그인` -> `내정보`에서 API 키를 확인합니다.
5. 직접 Bareun.ai API 서버를 사용할 때만 Obsidian `설정` -> `Korean Grammar Assistant` -> `API 연결``Bareun.ai API 키`에 입력합니다. 기본 프록시를 사용할 때는 비워둘 수 있습니다.
## 부산대 맞춤법 검사기 API 키 받기