¿Cuál es la mejor manera de editar el file Readme.md de GitHub?

¿Cuál es la mejor manera de editar el file Readme.md de GitHub?

Me encuentro editando el file Léame, luego lo presiono, veo errores o errores de formateo, lo edito de nuevo y luego lo presiono …

Realmente hace un número en el historial de compromiso.

¿Hay una mejor manera? ¿O no debería preocuparme por el historial de compromisos, y simplemente ir a las bananas en el file Léame?

Tal vez ni siquiera debería usar el file Léame, sino usar páginas GH ?


¿Cómo puedo probar cómo se verá mi file readme.md antes de comprometerme con github? – Acabo de encontrar una pregunta similar, pero más preguntas detalladas anteriormente.

Solo edito el file léame en github como un file sin formatting. Puede ver una vista previa antes de confirmar los cambios.

http://prose.io es una gran herramienta! Está alojado en páginas github y es una aplicación sin bases de datos que funciona totalmente a través de la API github. Tiene algunas características perfectas para la experiencia del editor si tienes un website de GitHub Jekyll también.

Y oye, ¡es de código abierto! http://github.com/prose/prose

Estoy usando Atom , es un editor de text de Github

Puede tener una vista previa instantánea al lado de la otra. No tiene que cambiar de aplicación o ejecutar ningún command adicional.

El acceso directo de vista previa es Ctrl + Shift + m , o puede verificar debajo de la image.

enter image description here

Sugiero stackedit que es un editor en línea. No necesita instalar nada.

Además, admite drag and drop el file en el editor.

Además, admite una vista de cambio en línea, ¡lo que lo hace más poderoso!

Además, puede save, publicar, compartir o download el file.

Una vez que sepa cómo formatearlo , puede minimizar los commits a less que no esté cometiendo errores de ortografía 🙂

Puede usar cualquiera de las siguientes marcas:

  • .markdown ( Redcarpet )
    • gem install networkingcarpet
  • .textil
    • gem install RedCloth
  • .rdoc
    • gem install rdoc -v 3.6.1
  • .org
    • gem install org-ruby
  • .criollo
    • gem install creole
  • .mediawiki
    • gem install wikicloth
  • .rst
    • easy_install docutils
  • .asciidoc
    • brew install asciidoc
  • .vaina
    • Pod::Simple::HTML viene con Perl> = 5.10.
    • Pod :: Simple from CPAN debe instalarse en versiones inferiores.
  • .TXT
    • el text plano funciona bien también, si no te importa formatear

Yo uso http://dillinger.io/ . Copie y pegue el contenido del file README.md, edítelo y vuelva a traerlo. El mejor editor de rebajas que he encontrado.

Con respecto a las páginas Léame vs GH, tenga en count que el file léame debe ser exactamente eso: un file Léame que actúa como un punto de partida útil para la información (instrucciones de installation, un enlace a la página del proyecto, etc.) incluido en un file descargado copy de file de su proyecto. Supongamos que descargo su proyecto como usuario final. Extraigo el file. ¿Qué necesito saber ahora ? Eso es lo que tiene que estar en el file Léame.

Si está utilizando el file Léame como el lugar de reference para get información sobre su proyecto debido a qué tan prominentemente GitHub lo muestra en la página del proyecto, definitivamente debe pensar en usar GH Pages.

Un poco tarde para el juego, pero escribí una pequeña CLI en Python para hacer exactamente esto. Se llama Grip (Github Readme Instant Preview) .

La vista previa en GitHub es agradable para hacer pequeñas ediciones, pero personalmente me encuentro invirtiendo mucho time editando el file README. Como señala @Zorayr, debe tener cuidado con la vista previa de GitHub y, lo que es peor, no puede save nueva prosa temporalmente para editar / reescribir más tarde sin comprometer realmente su borrador. Eso es más ruido de lo necesario en tu historial de git.

Con Grip, todos tus cambios son locales hasta que estés listo. Y puede usar el editor con el que se sienta más cómodo.

Instalarlo con:

 $ pip install grip 

Y para usarlo, simplemente:

 $ grip 

Luego, visite localhost:5000 para ver el file readme.md en esa location.

También puede especificar su propio file:

 $ grip CHANGES.md 

Y cambia el puerto:

 $ grip 8080 

O combine los dos anteriores:

 $ grip CHANGES.md 8080 

Incluso puede renderizar el marcado con sabor a GitHub (es decir, cómo se emiten los comentarios y los problemas), opcionalmente con context de repos para references de hyperlink automático a otros problemas:

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

Otras características notables:

  • Renders páginas para que aparezcan exactamente como en GitHub
  • Bloques cercados
  • API de Python
  • Navega entre los files vinculados
  • Exportar un documento renderizado a un file

Espero que esto ayude. Compruébalo .

(Nota: esta es una nueva publicación de esta respuesta con algunas ediciones para el context).

Hay un complemento sublime que le permite get una vista previa de su rebaja, Github o rebaja normal, en su browser. Bastante fácil de usar, y tiene atajos de keyboard. Lo estoy usando en Sublime Text 3.

Para Mac hay una buena herramienta gratuita http://mouapp.com/ . Tienes una vista previa en vivo de tu código en la window separada.

Simplemente vaya a su repository de Github a través del website de Github y click su file README.md.

Tendrá algunos botones a la derecha de la pantalla "Raw, Blame, History …" y un button "editar" con un ícono de lápiz.

Haga clic en él, ahora tiene un editor que le permite escribir algo de descuento y actualizar / previsualizar su file README.

edita el archivo README.md de Github

Un tipo en Github lanzó esto hace solo 3 meses. Quizás haya leído esta publicación. https://github.com/gedex/preview-github-readme.md

Es un file php y simplemente apunta a la url y agrega su file como un param ie

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

Y lo ejecutará contra su api.

Hay otro buen repository de git que hace algo similar, pero solo usa html y javascript. https://github.com/dzello/preview_markdown_locally Creo que el primero debería ser más preciso. También me gusta usar el editor en su sitio. +1 a Matt Esch

Yo uso este editor en línea stackedit.io . es perfecto

Encontré Dillinger.io útil para editar files README.md usando un editor en línea.

Yo uso Brackets . Después de eso instalo la extensión Markdown Preview que me permite verificar la versión final de mi .md en time real. Muy útil.

Utiliza esta hoja de trucos para ayudarte en https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

Dos paths:

  1. Vaya a su repository y click readme.md y select la opción de edición. Entonces puede editarlo en línea usando la hoja de trucos.

  2. Vaya a su repository local donde lo clonó y editó usando la hoja de trucos.

Pero recomiendo ir con la edición en línea donde se puede ver la vista previa en vivo 🙂

Si está utilizando IntelliJ cree un file con la extensión de file .md . IntelliJ mostrará automáticamente una vista previa de ese file al editarlo.

¿Has intentado usar Stack Edit ? Convierte html (o text) en un descuento. Puede acceder a él en su website o utilizando la aplicación de Chrome. Aquí puede crear títulos y lists en el editor y le mostrará el text correspondiente en formatting de networkingucción. Luego puede save, publicar, compartir o download el file.

Si utiliza el browser Chrome, puede usar la extensión que construyo MarkView para ver su file Markdown local.

Escribí un único file HTML pequeño para get una vista previa de las lecturas de GitHub . Utiliza la API de GitHub para representar el Markdown en HTML y GitHub Primer CSS para darle un estilo al HTML.

El file HTML usa una request Ajax para get su README.md. Use lo que quiera (su editor de text favorito) para editar su file README.md, luego use el file HTML para previsualizarlo.

Edite el file en su computadora con el editor que prefiera.

Acepte los cambios y empújelos a una nueva sucursal temporal que nadie más está mirando todavía, tal vez una sucursal en su bifurcación personal del proyecto.

Vea el file en github y verifique que esté satisfecho con la representación html. Si no estás contento con editar el file, git commit --amend y git push --force hasta que lo estés.

Ahora fusiona tu compromiso en una twig que a otras personas les importa, e impulsa eso. Es posible que desee eliminar su nueva sucursal.