Metadata-Version: 2.4
Name: tmd-cli
Version: 0.2.0
Summary: A keyboard-first terminal Markdown editor
Project-URL: Homepage, https://github.com/typemnm/tmd
Project-URL: Repository, https://github.com/typemnm/tmd
Project-URL: Issues, https://github.com/typemnm/tmd/issues
Project-URL: Changelog, https://github.com/typemnm/tmd/releases
Author: typemnm
License-Expression: MIT
License-File: LICENSE
Keywords: editor,markdown,terminal,textual,tui
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Text Editors
Requires-Python: >=3.11
Requires-Dist: markdown-it-py<5,>=4.0
Requires-Dist: mdit-py-plugins<1,>=0.6
Requires-Dist: textual<9,>=8.2
Provides-Extra: dev
Requires-Dist: build<2,>=1.2; extra == 'dev'
Requires-Dist: pytest-asyncio<2,>=1.4; extra == 'dev'
Requires-Dist: pytest<10,>=9; extra == 'dev'
Requires-Dist: ruff<1,>=0.12; extra == 'dev'
Requires-Dist: twine<7,>=6; extra == 'dev'
Description-Content-Type: text/markdown

# tmd

[![CI](https://github.com/typemnm/tmd/actions/workflows/ci.yml/badge.svg)](https://github.com/typemnm/tmd/actions/workflows/ci.yml)
[![PyPI](https://img.shields.io/pypi/v/tmd-cli.svg)](https://pypi.org/project/tmd-cli/)
[![Python](https://img.shields.io/pypi/pyversions/tmd-cli.svg)](https://pypi.org/project/tmd-cli/)

`tmd`는 키보드 중심의 터미널 마크다운 편집기입니다. Textual 기반 TUI에서 파일 탐색, 최근 파일, 마크다운 문법 강조, 문서 검색, 수동 저장과 2초 지연 자동 저장을 제공합니다.

> 현재 버전은 마크다운 원문을 스타일링하는 구문 강조 편집기입니다. 마크다운 기호를 숨기는 완전한 WYSIWYG 렌더러는 아직 제공하지 않습니다.

`Ctrl+P`를 누르면 현재 파일을 로컬 웹 브라우저 탭에 읽기 전용으로 렌더링해서 보여주고, 타이핑하는 동안 실시간으로 갱신됩니다. 서버는 `127.0.0.1`에만 바인딩됩니다.

## 설치

Python 3.11 이상이 필요합니다. CLI 도구를 독립된 환경에 설치하는 `pipx` 사용을 권장합니다.

```bash
pipx install tmd-cli
tmd --version
```

GitHub 릴리스에서 직접 설치하려면 다음 명령을 사용합니다.

```bash
pipx install git+https://github.com/typemnm/tmd.git@v0.1.0
```

> **주의:** `pip install tmd`는 이 프로젝트가 아닌 별개의 PyPI 패키지를 설치합니다. 이 프로젝트의 배포 이름은 `tmd-cli`이고 실행 명령은 `tmd`입니다.

소스 개발 설치:

```bash
git clone https://github.com/typemnm/tmd.git
cd tmd
python -m pip install -e '.[dev]'
```

## 사용법

```bash
tmd                 # 현재 디렉터리를 탐색기 루트로 사용
tmd note.md         # 파일을 열고 부모 디렉터리를 탐색
tmd ~/Documents     # 지정 디렉터리를 탐색
tmd --version
```

## 주요 단축키

| 키 | 동작 |
|---|---|
| `Ctrl+S` | 저장, 새 문서는 Save As 표시 |
| `Ctrl+Shift+S` | 다른 이름으로 저장 |
| `Ctrl+O` | 파일 열기 |
| `Ctrl+F` | 문서 검색 |
| `Ctrl+N` | 새 문서 |
| `Ctrl+Q` | 안전하게 저장 후 종료 |
| `Ctrl+B` / `Ctrl+I` | 선택 영역 굵게 / 기울임 |
| `Ctrl+\` | 사이드바 토글 |
| `Ctrl+P` | 웹 브라우저 미리보기 켜기/끄기 |
| `F1` | 도움말 |

기존 파일은 마지막 입력 2초 후 자동 저장됩니다. 파일 전환이나 종료 전에 대기 중인 변경 사항은 즉시 저장됩니다. 제목 없는 문서는 저장·버리기·취소 중 하나를 선택할 수 있습니다.

## 개발 및 테스트

```bash
python -m pip install -e '.[dev]'
ruff check tmd_cli tests
pytest -q
python -m build
python -m twine check dist/*
```

기여 방법은 [CONTRIBUTING.md](CONTRIBUTING.md), 변경 내역은 [CHANGELOG.md](CHANGELOG.md)를 참고하세요.

## 라이선스

[MIT License](LICENSE)
