Какой лучший способ редактировать GitHub Readme.md?

Какой лучший способ редактировать GitHub Readme.md?

Я нахожу, что редактирую Readme, затем нажимаю его, вижу ошибки или ошибки форматирования, снова редактирую его, а затем нажимаю на него...

Это действительно число в истории фиксации.

Есть ли лучший способ? Или мне не нужно заботиться о истории фиксации, а просто идти бананы на Readme.

Возможно, мне даже не нужно использовать Readme, но вместо этого используйте страницы GH?


Как я могу проверить, как будет выглядеть мой файл readme.md, прежде чем отправляться в github? - Просто нашел аналогичный вопрос, но более подробные вопросы выше.

+187
источник поделиться
21 ответ

Я просто редактирую readme на github как необработанный файл. Перед выполнением изменений вы можете просмотреть предварительный просмотр.

+134
источник

http://prose.io - отличный инструмент! Он размещался на страницах github и представляет собой приложение без базы данных, которое полностью работает через API github. Имеет некоторые опрятные функции для работы с редактором, если у вас также есть сайт GitHub Jekyll.

И эй, это с открытым исходным кодом! http://github.com/prose/prose

+57
источник
другие ответы

Связанные вопросы


Похожие вопросы

Я использую Atom, это текстовый редактор от Github

У вас может быть мгновенный предварительный просмотр. Вам не нужно переключать приложение или выполнять какую-либо дополнительную команду.

Предварительный ярлык Ctrl + Shift + m, Или вы можете проверить изображение ниже.

enter image description here

+50
источник

Я предлагаю stackedit, который является онлайн-редактором. Вам не нужно ничего устанавливать.

Кроме того, он поддерживает перетаскивание файла в сам редактор.

Кроме того, он поддерживает просмотр онлайн-изменений, что делает его более мощным!

Кроме того, вы можете сохранить, опубликовать, поделиться или загрузить файл.

+34
источник

Как только вы узнаете как его форматировать, вы можете свести к минимуму коммиты, если вы не совершаете орфографические ошибки:)

Вы можете использовать любую из следующих надстроек:

  • .markdown(Redcarpet)
    • gem install redcarpet
  • .textile
    • gem install RedCloth
  • .rdoc
    • gem install rdoc -v 3.6.1
  • .org
    • gem install org-ruby
  • .creole
    • gem install creole
  • .mediawiki
    • gem install wikicloth
  • .rst
    • easy_install docutils
  • .asciidoc
    • brew install asciidoc
  • .pod
    • Pod::Simple::HTML поставляется с Perl >= 5.10.
    • Pod:: Простой от CPAN должен быть установлен на более низких версиях.
  • .txt
    • обычный текст отлично работает, если вам не нужно форматировать
+15
источник

Я использую http://dillinger.io/. Скопируйте и вставьте содержимое файла README.md, отредактируйте его и верните. Лучший редактор уценок, с которым я столкнулся.

+10
источник

Что касается страниц readme vs GH, имейте в виду, что файл readme должен быть таким: файл readme, который служит полезной отправной точкой для информации (инструкции по установке, ссылка на страницу проекта и т.д.) в скачанной архивной копии вашего проекта. Предположим, я загружаю ваш проект в качестве конечного пользователя. Я извлекаю архив. Что мне нужно знать прямо сейчас? Это то, что должно быть в файле readme.

Если вы используете файл readme в качестве места для получения информации о своем проекте, так как именно GitHub отображает его на странице проекта, вам определенно стоит подумать об использовании страниц GH.

+8
источник

Немного поздно в игре, но я написал небольшую CLI в Python, чтобы сделать именно это. Он называется Grip (мгновенный просмотр Github Readme).

Предварительный просмотр в GitHub хорош для внесения небольших изменений, но я лично считаю, что очень много времени редактирую README. Как указывает @Zorayr, вам нужно быть осторожным с предварительным просмотром GitHub, и, что еще хуже, вы не можете временно сохранить новую прозу сейчас, чтобы отредактировать/переписать позже, не нажимая свой черновик. Это больше шума в вашей истории git, чем необходимо.

С помощью Grip все ваши изменения будут локальными, пока вы не будете готовы. И вы можете использовать любой редактор, с которым вам наиболее удобно.

Установите его с помощью:

$ pip install grip

И использовать его просто:

$ grip

Затем посетите localhost:5000, чтобы просмотреть файл readme.md в этом месте.

Вы также можете указать свой собственный файл:

$ grip CHANGES.md

И измените порт:

$ grip 8080

Или объедините предыдущие два:

$ grip CHANGES.md 8080

Вы даже можете отобразить GitHub-Flavored Markdown (то есть, как отображаются комментарии и проблемы), необязательно с контекстом репо для ссылок на гиперссылку на другие проблемы:

$ grip --gfm --context=username/repo issue.md

Другие примечательные функции:

  • Отображает страницы так, как на GitHub
  • Огороженные блоки
  • API Python
  • Перемещение между связанными файлами
  • Экспорт отображаемого документа в файл

Надеюсь, это поможет. Проверьте его.

(Примечание. Это повторная публикация этого ответа с несколькими изменениями для контекста.)

+8
источник

Существует Sublime Plugin, который позволяет вам просмотреть свою уценку, Github или обычную уценку, в вашем браузере. Довольно проста в использовании, и у нее есть ярлыки клавиш. Я использую его в Sublime Text 3.

+5
источник

Для mac есть хороший бесплатный инструмент http://mouapp.com/. У вас есть живой просмотр вашего кода в отдельном окне.

+4
источник

Просто перейдите на свой рефит Github через сайт Github и нажмите на свой файл README.md.

У вас есть несколько кнопок справа от экрана "Raw, Blame, History..." и кнопка "edit" с пиктограммой карандаша.

Нажмите на него, теперь у вас есть редактор, который позволяет писать некоторую уценку и обновлять/просматривать ваш файл README.

редактировать файл Github README.md

+4
источник

Парень на github выпустил это всего 3 месяца назад. Возможно, он прочитал этот пост. https://github.com/gedex/preview-github-readme.md

Это php файл, и вы просто указываете на URL-адрес и добавляете свой файл в качестве параметра, т.е.

http://localhost/preview_github_readme.php?file=/path/to/readme.md

И он будет запускать его против своих api.

Существует еще один хороший репозиторий git, который делает что-то подобное, но просто использует html и javascript. https://github.com/dzello/preview_markdown_locally Я считаю, что первое должно быть более точным. Мне также нравится просто использовать редактор на своем сайте. +1 к Мэтту Эшу

+2
источник

Я использую этот онлайн-редактор stackedit.io. он идеален

+2
источник

Я нашел Dillinger.io полезный для редактирования файлов README.md с помощью онлайн-редактора.

+2
источник

Я использую Brackets. После этого я устанавливаю расширение предварительного просмотра Markdown, которое позволяет мне проверить окончательную версию моего .md в режиме реального времени. Очень полезно.

+1
источник

Используйте этот лист обмана, чтобы помочь вам https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

Два способа:

  • Перейдите к своему репо и нажмите кнопку readme.md и выберите вариант редактирования. Таким образом, вы можете редактировать его онлайн, используя чит-лист.

  • Перейдите в свое местное репо, где вы клонировали и редактировали с помощью обмана.

Но я рекомендую перейти с онлайн-редактированием, где вы можете посмотреть предварительный просмотр в прямом эфире:)

+1
источник

Если вы используете IntelliJ, создайте файл с расширением файла .md. IntelliJ автоматически покажет предварительный просмотр этого файла при его редактировании.

+1
источник

Вы пытались использовать Stack Edit? Он преобразует html (или текст) в уценку. Вы можете получить к нему доступ на своем веб-сайте или с помощью приложения Chrome. Здесь вы можете создавать заголовки и списки в редакторе, и он покажет вам соответствующий текст в формате уценки. Затем вы можете сохранять, публиковать, публиковать или загружать файл.

+1
источник

Если вы используете браузер Chrome, вы можете использовать расширение, которое я создаю MarkView, чтобы просмотреть локальный файл Markdown.

0
источник

Я написал один, маленький HTML файл для просмотра GitHub readmes. Он использует API GitHub для рендеринга Markdown в HTML и GitHub Primer CSS для стиля HTML.

В файле HTML используется запрос Ajax для получения README.md. Используйте все, что вам нравится (ваш любимый текстовый редактор), чтобы отредактировать README.md, а затем используйте файл HTML для его предварительного просмотра.

0
источник

Отредактируйте файл на своем компьютере любым редактором, который вы предпочитаете.

Зафиксируйте изменения и подтолкните их к новой временной ветке, к которой еще никто не смотрит - возможно, к вашей личной вилке проекта.

Просмотрите файл на github и убедитесь, что вы довольны рендерингом html. Если вы не довольствуетесь этим, отредактируйте файл git commit --amend и git push --force до тех пор, пока вы не выполните.

Теперь объедините свою фиксацию в ветку, которую другие люди волнуют, и нажмите ее. Вы можете удалить новую ветку.

0
источник

Посмотрите другие вопросы по меткам или Задайте вопрос