Cómo escribir un buen archivo Léame en Github
Autor SHyH5
Este artículo es uno de mis registros diarios. Es posible que muchas personas hayan escrito cosas relacionadas y las hayan escrito de manera más completa. . El propósito es solo compartir algunas de mis cosas diarias, ¡no comentes si no te gusta! ! ! !
Archivo LÉAME
Todos pueden estar familiarizados con los archivos LÉAME. Cuando subimos algunos de nuestros archivos de proyecto a GitHub, adjuntamos un archivo de descripción y se mostrará en el repositorio. en. Escribir usando la sintaxis de MarkDown hará que parezca más conciso y claro.
Explicación de sintaxis específica
Esto no implica la creación y edición del archivo Léame. Creo que las personas que han usado git estarán familiarizadas con esto. Las siguientes son algunas sintaxis comunes:
1.título
El primero es el título, que está en el signo = debajo del título del texto, y el número no está limitado;
El segundo es el título del medio, el título del medio está en el signo - debajo del título del texto, el número no está limitado;
El último es el subtítulo de cada nivel , que está dividido en seis niveles. Hay un signo # al comienzo de cada nivel y hay uno para cada nivel #, por ejemplo: el título del primer nivel es #, el título del segundo nivel es ##. y así sucesivamente hacia abajo. Los efectos de visualización relevantes son los siguientes:
Título grande
Título mediano
Título de primer nivel
Título de segundo nivel
Encabezados de nivel 3
Encabezados de nivel 4
Encabezados de nivel 5
Encabezados de nivel 6
++++ + ++ Línea divisoria manual +++++++++
2. Texto
El primero es el texto normal, el texto principal son saltos de línea, "& lt; br & gt;" (elimine espacios) o espacios dobles y un retorno de carro, como se muestra a continuación:
Este es un carácter de nueva línea que se puede usar para dividir una nueva línea.
Aquí, un carácter de nueva línea se utiliza para romper una nueva línea.
Aquí está el uso de espacios dobles y retornos de carro para romper líneas.
Luego está el texto de una sola línea y de varias líneas, que se puede lograr usando dos pestañas múltiples; Texto de línea y texto de una sola línea Lo mismo, siempre que haya dos caracteres de tabulación al principio de cada línea, por ejemplo
Hola, veloz
Estimado líder:
¡Hola!
Adiós
Finalmente, formatea el texto e inserta:
Fuente resaltada:
Utiliza la tecla Tab de arriba, el número 1. Las teclas de la izquierda rodean la fuente que debe configurarse. De la siguiente manera:
Hay una brillante luz de luna frente a la ventana, se sospecha que hay escarcha en el suelo
Negrita y cursiva:
Usando dos asteriscos incluir un párrafo de texto está en negrita, usar un asterisco para encerrar un bloque de texto está en cursiva.
Mira la luna brillante, inclina la cabeza y extraña tu ciudad natal
Cita:
Solo agrega > delante de la oración citada:
Pensamientos sobre una noche tranquila
Se sospecha que la brillante luz de la luna frente a la ventana es escarcha en el suelo.
La luz de la luna brilla intensamente frente a la ventana, que se sospecha que es escarcha en el suelo.
Mira hacia la luna brillante,
Mira hacia tu ciudad natal.