wake-up-neo.net

Markdown-Tag für Dokumenttitel

Gibt es keine Möglichkeit, den Dokumenttitel in einem Markdown-Dokument anzugeben?

Ich habe Markdown mit Sublime Text für die Erstellung vieler meiner persönlichen und geschäftlichen Dokumente verwendet. Ich möchte oft eine Art "Top-Level" Überschrift haben, die beispielsweise dem Titelstil in Word entspricht. Also zum Beispiel:

### Things to Do ###

At Home
=======
*    Mow the cat
*    Feed the lawn

At the Office
=============
*    Learn Markdown
*    Use Big-O notation in a clever way

Aber die ### Things to Do ###-Zeile wird von Markdown nicht respektiert, und ich kenne keine Alternative. Ist dort eines?

Ich könnte den Überschrift-Überschrift-1-Stil für den Titel verwenden und dann für den Rest die Überschrift-2, aber wenn ich eine tiefere Verschachtelung der Überschriften brauche, bin ich schnell überfordert. Und ein Titel ist im Grunde keine Überschrift an sich. Es wäre beispielsweise schön, wenn Markdown-zu-HTML-Parser den Titel für die Seite <title> sowie für einen Kopfzeilen-Kopfzeilen-Titel wie Word-Titel verwenden. 

35
OldPeculier

Ein interessanter Punkt bei Markdowns Design ist, dass HTML ausdrücklich erlaubt ist. HTML5 fügte semantische Seitenabschnitte hinzu, darunter <header> und <main>, die möglicherweise gut zu Ihrem Seitentitel passen.

Zum Beispiel:

<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>

Wenn Sie den Ausschluss von HTML bevorzugen, sollten Sie die Atx-Überschriften verwenden, um mehr als zwei Hierarchieebenen zu erhalten.

Zum Beispiel:

# 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
16
Ryan Prior

Wenn Sie sich auf Pandoc-Markdown beziehen, ist der einfachste Ansatz die Verwendung von '%', z.

% Document Title

# Header 1

content

## Header 2

## Header 2

siehe http://pandoc.org/README.html#metadata-blocks für weitere Informationen zum Pandoc-Markdown.

19
Ian Walters

Titel-Metadaten

Wenn Sie MultiMarkdown verwenden, können Sie oben im Dokument einige Metadaten hinzufügen

format: complete
title: This is a title for the web-page
css: http://example.com/main.css

First line of visible text

Der Titel wird in einen <title> im Abschnitt <head> aufgenommen

Sie können es auch per Referenz in den Hauptteil einfügen, indem Sie [%title]) verwenden.

Unterunterüberschriften

Es sollte kein Problem sein, ### am Anfang der ersten Zeile als Header der Ebene 3 zu erkennen, um <h3>-Tags zu generieren. Ich verwende dies in mehreren Implementierungen von Markdown/MultiMarkdown

Sie können es mit John Grubers Dingus , Markable usw. testen.

Überschrift versetzt

Bei einigen Markdown-/Multimarkdown-Implementierungen können Sie zumindest einen Versatz für generierte Überschriften angeben, sodass <h2> und <h3> anstelle von <h1> und <h2> generiert werden.

Auf diese Weise können Sie beispielsweise <h1>Title</h1> oder <h1>[%title]</h1> als erste Zeile Ihres Dokuments (nach Metadatendeklarationen) angeben.

Verweise

5
RedGrittyBrick

Ich schreibe Bücher und Forschungsarbeiten in Markdown, die ich ausschließlich auf GitHub und HTML-Titel-Tags in Markdown poste, funktionieren nicht auf GitHub. Daher verwende ich die Konvention, dass:

Document Title
==============

***This is a subtitle***

**Author:** *Me*

# Chapter One: Overview

Do you know the way?

---

# Chapter Two: Foo

Foo is the way...

---

Was am Ende aussieht:


Dokumenttitel

Dies ist ein Untertitel

Autor: _ ​​Ich

Kapitel 1: Übersicht

Weißt du den Weg?


Kapitel zwei: Foo

Foo ist der Weg ...


Ich verwende den ---, um Kapitel zu trennen, da es gut aussieht und das Auffinden des Kapitels im Text erleichtert. Dies stellt jedoch ein Problem dar, wenn das Markdown-Dokument groß wird. In diesem Fall friert das Markdown-Vorschaufenster Sie bei jeder Eingabe ein, wenn es aktualisiert wird, oder Grammarly beginnt mit dem Abhören und benötigt ein WIRKLICH lang Zeit. Dies ist die Begründung für die Verwendung des === H1-Titelformats. Wenn das Dokument groß wird, müssen Sie es aufteilen. In diesem Fall ist es ratsam, das Format zu verwenden:

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)

Das sieht dann so aus:


Dokumenttitel

Dies ist ein Untertitel

Autor: _ ​​Ich

<< Vorheriges Kapitel | Inhaltstabelle | Nächstes Kapitel >>


Kapitel zwei: Foo

Foo ist der Weg ...


<< Vorheriges Kapitel | Inhaltstabelle | Nächstes Kapitel >>


Ich habe auch auf die Verwendung des Wiki-Dateinamens für den Titel verzichtet, da er keine mit Bindestrich versehenen Wörter zulässt, was meine Kapitelüberschriften durcheinander bringt. Daher habe ich zu allen Dateinamen in Kleinbuchstaben gewechselt, beginnend mit dem Kapitelindex 01_chapter_name.md, 02_chapter_name-with-hyphens.md, ... Mit dem === H1 Title-Format und dem Verschieben meiner Markdown-Bücher in das Haupt-Repository, sodass ich Issue Driven Development und GitHub Issues and Projects mit einem Projekt pro Kapitel verwenden kann, damit ich mich an all die Dinge erinnern kann, die ich erledigen muss, und das Backlog durchgehen.

3
user2356685

Wenn Sie nichts dagegen haben, RStudio zu verwenden, generieren Rmd-Dateien (rmarkdown) den Titel mithilfe eines Metadatenabschnitts oben und verwenden dann #+ für Header.

Links

0
abalter