markdown - que - title html ejemplos

Etiqueta de reducción para el título del documento (4)

¿No hay forma de indicar el título del documento en un documento de Markdown?

He venido a utilizar Markdown con Sublime Text para preparar muchos de mis documentos personales y comerciales. A menudo quiero tener un tipo de encabezado de "nivel superior" análogo al estilo Título en Word, por ejemplo. Así por ejemplo:

### Things to Do ### At Home ======= * Mow the cat * Feed the lawn At the Office ============= * Learn Markdown * Use Big-O notation in a clever way

Pero Markdown no respeta la línea ### Things to Do ### , y no conozco una alternativa. Hay uno

Podría usar el estilo Título 1 para el título y luego el Título 2 para el resto, pero si necesito un agrupamiento más profundo de títulos, rápidamente me quedo sin profundidad. Y, después de todo, un título fundamentalmente no es un título per se. Sería bueno, por ejemplo, si los analizadores Markdown-to-HTML usaran el Título para la página <title> así como para un encabezado de inicio de página a la palabra títulos.

Título de metadatos

Si está utilizando MultiMarkdown, puede agregar algunos metadatos en la parte superior del documento

format: complete title: This is a title for the web-page css: http://example.com/main.css First line of visible text

El título se incluirá en un <title> en la sección <head>

También puede incluirlo por referencia en el cuerpo usando [%title] )

Sub-subtítulos

No debería haber ningún problema para reconocer ### al comienzo de la primera línea como un encabezado de nivel 3 para generar etiquetas <h3> . Lo uso en varias implementaciones de Markdown / MultiMarkdown

Puedes probarlo usando el Dingus de John Gruber , Markable , etc.

Desplazamiento de rumbo

Al menos algunas implementaciones de Markdown / Multimarkdown le permiten especificar un desplazamiento para los encabezados generados para que genere <h2> y <h3> lugar de <h1> y <h2> .

Esto le permitiría poner, por ejemplo, <h1>Title</h1> o <h1>[%title]</h1> como la primera línea de su documento (después de las declaraciones de metadatos).

Referencias

Escribo libros y artículos de investigación en Markdown que publico exclusivamente en GitHub y las etiquetas de título HTML en Markdown no funcionan en GitHub, así que uso la convención de que:

Document Title ============== ***This is a subtitle*** **Author:** *Me* # Chapter One: Overview Do you know the way? --- # Chapter Two: Foo Foo is the way... ---

Que termina pareciendo:

Titulo del documento

Este es un subtítulo.

Autor: yo

Capítulo uno: Descripción general

¿Sabes el camino?

Capítulo Dos: Foo

Foo es el camino ...

Utilizo --- para separar capítulos porque se ve bien y ayuda a encontrar el capítulo en el texto. Sin embargo, esto presenta un problema cuando el documento de Markdown se agranda, en cuyo caso, la ventana de vista previa de Markdown comienza a congelarse cada vez que se escribe a medida que se actualiza o Grammarly comienza a salir y toma un tiempo REALMENTE largo. Esta es la justificación para usar el formato de título === H1 porque cuando el documento crece, es necesario dividirlo, en cuyo caso es bueno usar el formato:

Document Title ============== ***This is a subtitle*** **Author:** *Me* [<< Previous Chapter](URL) | [Content Table](URL) | [Next Chapter >>](URL) --- # Chapter Two: Foo Foo is the way... --- [<< Previous Chapter](URL) | [Content Table](URL) | [Next Chapter >> ](URL)

Que luego se ve como:

Titulo del documento

Este es un subtítulo.

Autor: yo

<< Capítulo anterior | Tabla de contenido | Siguiente Capítulo >>

Capítulo Dos: Foo

Foo es el camino ...

<< Capítulo anterior | Tabla de contenido | Siguiente Capítulo >>

También he dejado de usar el nombre de archivo de Wiki para el Título porque no permite palabras con guiones, lo que confunde los títulos de mis capítulos, así que 01_chapter_name.md a todos los nombres de archivos en minúsculas que comienzan con el índice del capítulo 01_chapter_name.md , 02_chapter_name-with-hyphens.md , ... con el formato de título H1 === y moví mis libros de Markdown al repositorio principal para que pueda usar Issue Driven Development y GitHub Issues and Projects con un Proyecto por capítulo para poder recordar todas las cosas para hacer y conseguir a través de la cartera.

Si se está refiriendo específicamente a pandoc markdown, el enfoque más simple es utilizar ''%'', por ejemplo

% Document Title # Header 1 content ## Header 2 ## Header 2

consulte http://pandoc.org/README.html#metadata-blocks para obtener más información sobre pandoc markdown.

Uno de los puntos interesantes del diseño de Markdown es que HTML está explícitamente permitido. HTML5 agregó secciones de páginas semánticas, incluyendo <header> y <main>, que pueden ser una buena opción para el título de su página.

Por ejemplo:

<header> Things to Do ============ </header> <main> At Home ======= * Mow the cat * Feed the lawn At the Office ============= * Learn Markdown * Use Big-O notation in a clever way </main>

Si prefiere excluir HTML, puede usar los encabezados de estilo Atx para obtener más de dos niveles de jerarquía.

Por ejemplo:

# Things to Do ## At Home * Mow the cat * Feed the lawn ## At the Office ### Morning * Learn Markdown * Use Big-O notation in a clever way ### Afternoon * Read e-mails * Scrutinize LOLcats