github.com에서 README.md 작업 [닫힘]
답변:
문제의 마크 업은 Daring Fireball 블로그의 저자 인 John Gruber가 만든 Markdown 입니다. Markdown의 원래 소스는 Daring Fireball-Markdown 에서 찾을 수 있습니다. .
Markdown 방언이 많이 있으며 Github에 대한 문서는 Github Flavored Markdown 에서 찾을 수 있습니다. 페이지 .
그 페이지에서 좋은 팁 :
Markdown 편집기로 Github 페이지에서 M 을 눌러 치트 시트를 표시합니다.
Github Markdown 실시간 미리보기 페이지를 사용하여 Markdown 문서를 테스트 할 수도 있습니다 .
2012-11-08 업데이트 : Markdown 구문을 표준화하기위한 노력이 진행 중입니다. 참조 제프 앳 우드, 코딩 공포 - 마크 다운의 미래 와 W3C 마크 다운 커뮤니티 그룹 .
2014-09-09 업데이트 : CommonMark 마크 다운 표준 및 사양이 출시되었습니다.
게임에 조금 늦었지만 Python으로 작은 CLI를 작성했습니다. 그것은라고 그립 (Github의 추가 정보 인스턴트 미리보기) . Patrick의 답변에 추가하면 "내 브라우저에서 로컬로 내 문서를 검토"할 수 있습니다.
다음과 함께 설치하십시오.
$ pip install grip
그리고 그것을 사용하려면 간단히 :
$ grip
그런 다음 방문 localhost:5000하여readme.md 해당 위치에서 파일 .
고유 한 파일을 지정할 수도 있습니다.
$ grip CHANGES.md
포트를 변경하십시오.
$ grip 8080
또는 이전 두 가지를 결합하십시오.
$ grip CHANGES.md 8080
선택적으로 다른 문제에 대한 자동 하이퍼 링크 참조에 대한 repo 컨텍스트를 사용하여 GitHub 기반 마크 다운 (즉, 댓글 및 문제가 렌더링되는 방식)을 렌더링 할 수도 있습니다.
$ grip --gfm --context=username/repo issue.md
간결함을 위해 CLI 도움말을 사용하여 나머지 옵션 및 세부 정보를 참조하십시오.
$ grip -h
주목할만한 특징 :
- GitHub에서와 똑같이 표시되도록 페이지를 렌더링합니다.
- 울타리 블록
- Python API
- 링크 된 파일 간 이동
- 렌더링 된 문서를 파일로 내보내기
도움이 되었기를 바랍니다. 그것을 확인하십시오 .
여기에 멋진 온라인 / 라이브 편집기가 있습니다.
http://jbt.github.io/markdown-editor/
PreviewGitHub 에도 버튼이 있습니다.
에서 편집을 클릭했을 때이 버튼이 나타나는 다음 스크린 샷을 참조하십시오 README.md.
IMHO 라이브 편집기 는 현재 GitHub에서 사용 가능한 편집기 보다 낫습니다.
최신 정보
방금 MarkdownVS를 사용하는 경우 Visual Studio를 검색 한 후 Web Essentials를 설치 하고Markdown Visual Studio 내에서 바로 지원을받을 수 있음을 발견했습니다. 멋지다!
다음이 있습니다.
- 구문 강조 => Markdown 구문의 전체 색상 화
- 임베디드 언어 용 Intellisense ( W00T ) => GitHub의 임베디드 언어 기능은```언어 구문을 지원하여 완벽하게 지원됩니다.
- 미리보기 창 => 렌더링 된 HTML의 나란히있는 미리보기 창보기
- HTML로 컴파일 => Markdown 파일을 마우스 오른쪽 버튼으로 클릭하고 Markdown을 HTML로 컴파일을 선택합니다. 이렇게하면 Markdown 파일 아래에 중첩 된 .html 파일이 생성되고 Markdown 파일이 변경 될 때 동기화 상태가 유지됩니다.
- Custom Stylesheet => 솔루션 별 Stylesheet를 추가하여 미리보기 창의 스타일을 제어 할 수 있습니다.
여기 에 대한 자세한 내용 .
2014 년 2 월부터 " Rendered Prose Diffs "를 사용하면 마크 다운 파일에서 렌더링 된 diff 버전도 볼 수 있습니다.
산문 파일을 포함한 커밋 및 풀 요청은 이제 소스 및 렌더링 된 뷰를 제공 합니다.
텍스트가 아닌 변경 사항은 낮은 키 점선 밑줄과 함께 나타납니다. 변경된 내용을 보려면 텍스트 위로 마우스를 가져갑니다.
또 다른 옵션-Github의 새로운 텍스트 편집기 인 Atom은 편집 할 때 github-flavoured markdown을 렌더링합니다. 참조 https://atom.io/를
장기적으로 (맥주처럼) 공짜가 될지 모르겠습니다.
다른 도구가 충분하다는 것을 찾지 못했습니다. 원했습니다.
- 오프라인 편집 기능
- 일반 마크 다운이 아니라 실제 Github 맛 마크 다운
이것이 내가 궁극적으로 정한 것입니다 : https://github.com/ypocat/gfms
> gfms
Github Flavored Markdown Server.
Run in your project's root directory.
Usage: gfms
Options:
-p, --port Port number to listen at. [required]
-h, --host Host address to bind to. [default: "localhost"]
--proxy if behind a proxy, proxy url.
-a, --api Render using Github API.
-n, --no-api-on-reload Disable usage of Github API when the doc is manually reloaded.
그래서 별칭을 지정했습니다.
alias gm='gfms -a -p 8070'
이 -p옵션을 사용하면 Github API에 도달하고 실제 현재 Github CSS를 사용하므로 놀랄 일이 없습니다.