Skip to main content

A keyboard-first terminal Markdown editor

Project description

tmd

CI PyPI Python

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

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

설치

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

pipx install tmd-cli
tmd --version

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

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

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

소스 개발 설치:

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

사용법

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+\ 사이드바 토글
F1 도움말

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

개발 및 테스트

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

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

라이선스

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tmd_cli-0.1.0.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tmd_cli-0.1.0-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file tmd_cli-0.1.0.tar.gz.

File metadata

  • Download URL: tmd_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for tmd_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 da9a5954c9e191cbcfe0d44e8725addeeb23b968a9811c1e2043e18de9e890a5
MD5 4a78d3d8bd471c1b6afc9b2ed079aabb
BLAKE2b-256 b48ef4f191d605cbda7e721a305b88d368cafc56a24027caab7dbd63174eaec5

See more details on using hashes here.

Provenance

The following attestation bundles were made for tmd_cli-0.1.0.tar.gz:

Publisher: release.yml on typemnm/tmd

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tmd_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: tmd_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 14.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for tmd_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cd0b8b915002f8feaf46c6d1146955ea8d87f03700e51aeac48e7cb80a5afd36
MD5 aa27998894805b9dcf05d2ff4da74b7a
BLAKE2b-256 d490ce7cfbd2c727899631c5ccad23df4cf7ca7bae14d9470b99242d767ce568

See more details on using hashes here.

Provenance

The following attestation bundles were made for tmd_cli-0.1.0-py3-none-any.whl:

Publisher: release.yml on typemnm/tmd

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page