README.md를 미리보기 위한 GitHub CLI 확장

GitHub에 푸시하기 전에 README.md를 미리 보고 싶다고 생각한 적이 있습니까? 나는 그것을 실현하기 위해 GitHub CLI 확장을 만들었습니다. 그것은 gh-markdown-preview로 명명되었습니다.

https://github.com/yusukebe/gh-markdown-preview

특징

종속성 없음 - gh 명령만 필요합니다.

제로 구성 - GitHub 액세스 토큰을 설정할 필요가 없습니다.

겉모습은 완전히 똑같습니다 - GitHub와 동일하게 볼 수 있습니다.

실시간 새로고침 - 브라우저를 새로고침할 필요가 없습니다.

요구 사항

설치하기 전에 GitHub CLI를 설치해야 합니다.

$ brew install gh

설치

$ gh extension install yusukebe/gh-markdown-preview

용법

$ gh markdown-preview README.md

또는 이 명령은 디렉토리에서 README 파일을 자동으로 감지합니다.

$ gh markdown-preview

그런 다음 Chrome, Firefox 또는 Safari에서 http://localhost:3333과 같은 로컬 웹 서버에 액세스합니다.



사용 가능한 옵션:

-p, --port     TCP port number of this server (default: 3333)
-r, --reload   Enable live reloading (default: false)

gh markdown-preview는 README.md와 같은 마크다운을 미리 볼 수 있는 GitHub CLI 확장입니다. gh markdown-preview 명령은 로컬 웹 서버를 시작하여 GitHub 스타일로 마크다운 문서 파일을 제공합니다.
gh markdown-preview 명령은 GitHub 웹 사이트에서 추출한 CSS와 함께 GitHub 공식 마크다운 API에서 가져온 HTML을 보여줍니다. 스타일은 거의 비슷합니다!

GitHub에 업로드하기 전에 렌더링된 README를 볼 수 있습니다!

더 많은 정보를 알고 싶다면 이 저장소를 확인하고 별표를 주세요 :)

yusukebe/gh-markdown-preview: GitHub CLI extension to preview README looks the same as GitHub.