Я не слишком знаком с облегченным языком разметки, используемым github при обновлении файлов README.
Где находятся ресурсы, которые я могу прочитать о том, как написать соответствующий синтаксис разметки для файлов README / wiki моей библиотеки с открытым исходным кодом?
И есть ли инструмент, с помощью которого я могу «просматривать мои документы локально в моем браузере», прежде чем отправлять обновленный README в свой репозиторий github?
( Повторная публикация этого ответа с некоторыми изменениями.)
Немного поздно к игре, но я написал небольшой интерфейс командной строки на Python. Это называется Grip (мгновенный просмотр Github Readme) . В дополнение к ответу Патрика это позволит вам «просматривать мои документы локально в моем браузере».
Установите его с помощью:
И использовать его просто:
Затем посетите,
localhost:5000
чтобы просмотретьreadme.md
файл в этом месте.Вы также можете указать свой собственный файл:
И поменяем порт:
Или объедините два предыдущих:
Вы даже можете отобразить разметку с добавлением GitHub (то есть, как отображаются комментарии и проблемы), при желании с контекстом репо для автоматической гиперссылки ссылок на другие проблемы:
Для краткости просмотрите остальные параметры и их подробности с помощью справки CLI:
Примечательные особенности:
Надеюсь это поможет. Проверить это .
источник
Здесь есть хороший онлайн-редактор:
http://jbt.github.io/markdown-editor/
Также есть
Preview
кнопка на GitHub.На следующем снимке экрана видно, что эта кнопка появляется, когда я нажимаю «Изменить»
README.md
.IMHO живой редактор лучше, чем текущий, доступный на GitHub.
ОБНОВИТЬ
Только что после поиска
Markdown
и Visual Studio я обнаружил, что если вы используете VS, вы можете установить Web Essentials и получитьMarkdown
поддержку прямо из Visual Studio. Это классно!Оно имеет:
Подробности здесь .
источник
Обратите внимание, что с февраля 2014 года с « Rendered Prose Diffs » вы также можете увидеть визуализированную версию diff в файле уценки:
источник
Другой вариант - новый текстовый редактор Github, Atom, будет отображать уценку со вкусом github, когда вы его редактируете. См. Https://atom.io/
Я не уверен, будет ли оно бесплатным (как пиво) в долгосрочной перспективе.
источник
С сегодняшнего дня вы можете предварительно просмотреть, как редактируете файл.
источник
Я не нашел, что другие инструменты достаточно хороши - я хотел:
В конечном итоге я остановился на этом: https://github.com/ypocat/gfms
Итак, я использовал псевдоним:
Использование этой
-p
опции приводит к обращению к Github API и использует текущий текущий CSS Github, поэтому никаких сюрпризов нет.источник