Cómo escribir una readme.md ¿archivo? (archivo markdown)
en este artículo, puedes aprender qué es un archivo markdown y cómo escribirlo. La mayoría de las veces puede encontrar este archivo en el repositorio remoto.
Qué es readme.md ¿archivo?
es un simple archivo de texto plano que contiene la información básica de los archivos y algunas guías. Se utiliza para escribir alguna guía de instalación o documentación básica dentro del directorio del proyecto. Los proveedores de repositorios más populares como GitHub, gitlab y bitbucket están utilizando readme.md file como descriptor de archivo.
¿qué es markdown?,
Markdown es un lenguaje de scripting que es muy ligero. Se utiliza para formatear texto plano a un diseño respectivo. Las rebajas se utilizan rápidamente en la escritura de contenido en algunos sitios web de publicaciones de blog. Convierte algo de texto sin formato al formato deseado en HTML. La simplicidad y fácil de entender está haciendo que el descuento sea más popular. Toma todo el texto del archivo markdown y lo convierte a HTML a través de una aplicación markdown o un compilador.,
Si usted es un principiante a la rebaja de archivo, entonces este artículo es para usted. Voy a escribir un readme.md archivo para que usted tenga una mejor comprensión de la secuencia de comandos markdown.
Aquí Estoy usando visual studio code IDE para escribir el archivo markdown. A continuación se muestran los pasos para crear un archivo markdown en visual studio code.,
Paso-1: Abra visual studio code y vaya file > new file
Paso-2: Nombre el archivo como readme.md o readme.markdown y guarde el archivo.
Paso-3: Busque y haga clic en el icono ‘open preview to the side’.
Paso 4: Empezar a escribir el guión.
encabezados
para escribir encabezados, debe agregar el símbolo hash # al principio de la línea., El número del símbolo hash aumentará el tipo de encabezado cambiará de acuerdo con eso.
Puede escribir hasta Título 6.
texto Normal
si desea escribir texto normal, escriba texto simple aquí, no es necesario agregar ninguna etiqueta que se convertirá automáticamente en texto.,
Hipervínculos
Usted puede agregar un hipervínculo en una rebaja de archivo mediante la siguiente etiqueta.
(targetURL)
por ejemplo (https://www.github.com)
también puede escribir el título del enlace (al pasar el mouse sobre el enlace del título aparecerá)
(targetURL "Link title")
por ejemplo,,div id=»fb7de34b3f»>
nota: asegúrese de que haya un único espacio debe ser entre targetURL y el título)
Fuerte y texto en cursiva
Usted puede escribir fuertes y texto en cursiva anexando subraya _ antes y el final de la línea, texto en cursiva agregar estrella doble ** antes y el final de la línea de fuertes/texto en negrita.,
_Italic text here_
Tachado
Si quiere lograr a través de una palabra o una línea, a continuación, agregue dos símbolo de tilde en el comienzo y el final de la línea.,
~~Strikethrough text~~
Images
You can add images in a markdown file by using the below tag.
!(TargetUrl)
Tables
You can write a table by using the below format of text.,
Quotes
If you want to write quotes the just add a > symbol at the beginning of the line.
>Your quote looks like this.
Code
You can write code by appending ` symbol at the beginning and end of the line.,
bloque de Código
Si desea escribir un bloque de código, a continuación, agregue « en el inicio y final del código.
Puede especificar su idioma después del « Al inicio de la línea.,
```Language
your code
```
Lista
Usted puede escribir una lista ordenada, desordenada lista, y la lista mezclada. Por favor, consulte el siguiente formato cómo escribir una lista.,»e15c8b1bd4″>
Horizontal line
If you want to add a horizontal line in the markdown file then simply add --- or ***
Note:
***is for thicker line.,
