tutorial examples git documentation github

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



markdown tutorial (21)

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

Además, admite arrastrar y soltar el archivo en el editor.

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

Además, puede guardar, publicar, compartir o descargar el archivo.

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

Me encuentro editando el archivo 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 archivo Léame?

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

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

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

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

Si está utilizando el archivo Léame como el lugar de referencia para obtener 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.

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 sitio web de GitHub Jekyll también.

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

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 archivo php y simplemente apunta a la url y agrega su archivo como un param ie

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

Y lo ejecutará contra su api.

Hay otro buen repositorio 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

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

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

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

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

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 tiempo real. Muy útil.

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

Puede usar cualquiera de las siguientes marcas:

  • .markdown ( Redcarpet )
    • gem install redcarpet
  • .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 texto plano funciona bien también, si no te importa formatear

Estoy usando Atom , es un editor de texto 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 comando adicional.

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

Simplemente vaya a su repositorio de Github a través del sitio web de Github y haga clic en su archivo README.md.

Tendrá algunos botones a la derecha de la pantalla "Raw, Blame, History ..." y un botón "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 archivo README.

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

Dos caminos:

  1. Vaya a su repositorio y haga clic en readme.md y seleccione la opción de edición. Entonces puede editarlo en línea usando la hoja de trucos.

  2. Vaya a su repositorio 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 :)

Edite el archivo 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 archivo en github y verifique que esté satisfecho con la representación html. Si no estás contento con editar el archivo, git commit --amend y git push --force hasta que lo estés.

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

Escribí un único archivo HTML pequeño para obtener 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 archivo HTML usa una solicitud Ajax para obtener su README.md. Use lo que quiera (su editor de texto favorito) para editar su archivo README.md, luego use el archivo HTML para previsualizarlo.

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 tiempo editando el archivo README. Como señala @Zorayr, debe tener cuidado con la vista previa de GitHub, y lo que es peor, no puede guardar 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 archivo readme.md en esa ubicación.

También puede especificar su propio archivo:

$ 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 contexto de repos para referencias de hipervínculo 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 archivos vinculados
  • Exportar un documento renderizado a un archivo

Espero que esto ayude. Compruébalo .

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

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

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

¿Has intentado usar Stack Edit ? Convierte html (o texto) en un descuento. Puede acceder a él en su sitio web o utilizando la aplicación de Chrome. Aquí puede crear títulos y listas en el editor y le mostrará el texto correspondiente en formato de reducción. Luego puede guardar, publicar, compartir o descargar el archivo.