Warum macht Markdown das? (Leerzeichen-Beschneidung und andere Funktionen)

[Rhababo]

Entschuldigen Sie den vagen Titel,

Ich bin dabei, einige der Funktionen in Markdown auf Discourse zu modifizieren, um sie besser an die Bedürfnisse meiner Community anzupassen, die von einem MyBB-Forum kommt.

Discourse ist meine erste Begegnung mit Markdown, und ich möchte den Ansatz verfolgen: „Reißen Sie keinen Zaun nieder, wenn Sie nicht wissen, warum er da ist.“ Es fällt mir jedoch schwer herauszufinden, warum Markdown bestimmte Aktionen ausführt, und ich hätte gerne einige Ressourcen, die mir helfen, dies zu verstehen (insbesondere wenn es Sicherheitsbedenken gibt, die ich übersehen könnte).

Die Antwort in diesem Thema enthielt einige gute allgemeine Referenzen, darunter frühe Diskussionen und ein (jetzt veraltetes) Plugin:

Rich Text Formatting (WYSIWYG)

Hi all, The users of my Discourse community are sports teachers who are not very technical, therefore the enforced use of markdown in the editor has created some formatting problems in posts. Ideally, we could enable a rich text WYSIWYG editor to make posting as simple and familiar as possible. Are there any ways to enable this or, if not, plans for inclusion on the roadmap? Cheers

Und dieser Beitrag war auf der Entwicklerseite äußerst hilfreich:

Developer's guide to Markdown extensions

Discourse uses a Markdown engine called Markdown-it. Here are some dev notes that will help you either fix bugs in core or create your new plugins. The Basics Discourse only contains a few helpers on top of the engine, so the vast majority of learning that needs to be done, is understanding Markdown It. The docs directory contains the current documentation. I strongly recommend reading: The architecture document to understand at a top level how the engine works. Development for basic d…

Aber auch hier möchte ich verstehen, warum bestimmte Funktionen existieren – damit ich sie am besten bewerten, entfernen oder anpassen kann.

Die aktuellen Funktionen, die ich im Visier habe, sind:

1. Entfernen von aufeinanderfolgenden Zeilenumbrüchen ohne <br> oder anderen Code.
2. Automatisches Erstellen von Codeblöcken in Zeilen mit 4 oder mehr führenden Leerzeichen.
3. Entfernen von führenden Leerzeichen in einer neuen Zeile.
4. Umwandlung jeder Zahlenfolge in eine nummerierte Liste in aufsteigender Reihenfolge.

Jeder Hinweis ist willkommen! Danke!

[Canapin (Coin-coin le Canapin)]

Ich bin sehr an diesem Thema interessiert, aber ich habe nicht das Wissen, um die meisten Ihrer Fragen zu beantworten.

Jedoch,

@Rhababo

Entfernen von aufeinanderfolgenden Zeilenumbrüchen ohne </br> oder anderen Code.

@Rhababo

Entfernen von führenden Leerzeichen in einer neuen Zeile.

Ich denke, Discourse möchte Beiträge sauber und leicht lesbar halten.
Durch das Entfernen von zusätzlichen Zeilenumbrüchen und das Kürzen von Leerzeichen am Anfang von Zeilen wird sichergestellt, dass Beiträge konsistent aussehen.
Dies hilft besonders, wenn Benutzer, manchmal sogar ohne es zu merken (ich kenne einige!), zufällige Leerzeichen oder Zeilen hinzufügen, die ihren Inhalt schwerer lesbar machen könnten.

@Rhababo

Umwandlung jeder Zahlenfolge in eine nummerierte Liste in aufsteigender Reihenfolge.

Es mag seltsam erscheinen, dies zu erzwingen, besonders wenn Sie tatsächlich eine Lücke in Ihrer Liste haben möchten, aber ich vermute, es geht darum, nummerierte Listen so einfach wie möglich zu halten, ohne dass jedes Element neu nummeriert werden muss, wenn Sie einen neuen Beitrag hinzufügen (oder in einem Wiki-Beitrag).

[Jagster (Jakke Lehtonen)]

@Canapin

Zeilen, die ihren Inhalt schwerer lesbar machen könnten

Tatsächlich kann es die Lesbarkeit erschweren, wenn alles sehr eng gehalten wird. Ein Absatz nach einem Bild kann ein Beispiel sein.

Aber… ich benutze \u003cbr /\u003e, also kein großes Problem.

Ein weiteres Aber… ich bin mir ziemlich sicher, dass die Bereinigungsoperation nichts mit einem besseren Leseerlebnis zu tun hat. Sie kommt vom Code selbst. Ähnlich wie die sehr müde Aussage, dass Markdown auf der „Code-Ebene“ besser lesbar ist. Der Endbenutzer befindet sich nie in dieser Situation.

Nun. Das ist reine Meta-Diskussion.

Aber ich weigere mich zu glauben, dass das Entfernen von Zeilen und Leerzeichen die Gesamterfahrung für den Endbenutzer tatsächlich verbessert.

[simon]

@Rhababo

Entfernen von aufeinanderfolgenden Zeilenumbrüchen ohne <br> oder anderen Code.

Ich bin mir nicht sicher, ob dies ein Problem für Sie löst, aber Discourse verfügt über eine Site-Einstellung traditional markdown linebreaks, die standardmäßig deaktiviert ist. Wenn sie aktiviert ist, sind zwei nachgestellte Leerzeichen erforderlich, um einen Zeilenumbruch zu erzeugen.

Hier ist ein Beispiel mit aktivierter Einstellung:

Hier ist ein Beispiel mit deaktivierter Einstellung (dem Standardwert der Einstellung):

@Rhababo

Discourse ist meine erste Begegnung mit Markdown,

Es lohnt sich vielleicht, diese Seite anzusehen und das 10-minütige Markdown-Tutorial auszuprobieren: Markdown Reference. Das Discourse-Tutorial für neue Benutzer verlinkt auf diese Seite, aber es wird wahrscheinlich von vielen Benutzern übersehen, die das Tutorial absolvieren:

[Heliosurge (Dan DeMontmorency)]

@Jagster

Aber ich weigere mich zu glauben, dass das Bereinigen von Zeilen und zusätzlichen Leerzeichen die Gesamterfahrung für den Endbenutzer tatsächlich verbessert.

Das macht ASCII-Art definitiv zu einer Herausforderung, um sie richtig darzustellen.

[Rhababo]

@Canapin

Ich denke, Discourse möchte Beiträge sauber und gut lesbar halten.
Durch das Entfernen zusätzlicher Zeilenumbrüche und das Kürzen von Leerzeichen am Anfang von Zeilen wird sichergestellt, dass Beiträge konsistent aussehen.

@Canapin

aber ich vermute, es ist, um nummerierte Listen so einfach wie möglich zu halten

Ich weiß die Einsicht wirklich zu schätzen. Meine Community hat eine große Sub-Community für Forenspiele/Geschichtenerzählen, in der Formatierungsfreiheit oft wichtiger ist als Konsistenz. Wenn der Hauptgrund für diese Funktionen wirklich darin besteht, ein konsistentes und vereinfachtes Erscheinungsbild beizubehalten, ist es wahrscheinlich sicher, sie für meinen Anwendungsfall zu entfernen oder ihnen zumindest eine vom Benutzer wählbare Umschaltmöglichkeit zu geben.

@simon

Es könnte sich lohnen, diese Seite anzusehen und das 10-minütige Markdown-Tutorial auszuprobieren: Markdown-Referenz.

Dies ist ein sehr hilfreiches Tutorial, und seine Betonung auf “schönen Text machen” scheint den zuvor erwähnten Ideen der Konsistenz zu folgen. Danke, dass du darauf hingewiesen hast.

[Rhababo]

Beim Lesen von Markdown bin ich auf diese Seite gestoßen, die ich besonders erhellend fand.

Dies ist, wie ich glaube, die ursprüngliche Beschreibung von Markdown, wie sie vom Commonmark-Team zitiert wird, und sie zeigt, dass ein Kernelement dessen, warum Markdown das tut, was es tut, auf seiner Nähe zu HTML beruht.

Zum Beispiel ist der erste Satz dort:

Markdown ist ein Text-zu-HTML-Konvertierungstool für Webautoren.

Und ich denke, einige dieser Eigenheiten von Markdown sind vielleicht weniger auf ihre organisatorischen Eigenschaften zurückzuführen und mehr auf den Wunsch, den Text sauber in den entsprechenden HTML-Code zu konvertieren.

Dies erklärt, warum Leerzeichen getrimmt werden, da HTML seine Leerzeichen trimmt.

Auch der Grund, warum jede Zahlenfolge in eine aufsteigende nummerierte Liste umgewandelt wird, wird mit folgendem etwas klarer:

Daring Fireball: Markdown Syntax Documentation

@https://daringfireball.net/projects/markdown/syntax#list

Es ist wichtig zu beachten, dass die tatsächlichen Zahlen, die Sie zur Markierung der Liste verwenden, keinen Einfluss auf die HTML-Ausgabe haben, die Markdown erzeugt. Das HTML, das Markdown aus der obigen Liste erzeugt, ist:

<ol>
<li>Bird</li>
<li>McHale</li>
<li>Parish</li>
</ol>

Wenn Sie die Liste stattdessen in Markdown wie folgt schreiben würden:

1.  Bird
1.  McHale
1.  Parish

oder sogar:

3. Bird
1. McHale
8. Parish

erhalten Sie exakt die gleiche HTML-Ausgabe. Der Punkt ist, wenn Sie möchten, können Sie Ordnungszahlen in Ihren geordneten Markdown-Listen verwenden, so dass die Zahlen in Ihrer Quelle mit den Zahlen in Ihrem veröffentlichten HTML übereinstimmen. Aber wenn Sie faul sein wollen, müssen Sie das nicht.

Markdown kümmert sich also nicht einmal um die Zahlen, weil geordnete Listen in HTML keine Zahlen zuweisen. (Der eigentliche Code in markdown-it prüft zwar das Zeichen an der ersten Position, aber nur, um die Nummerierung von diesem Zeichen aus zu starten).

Ich denke, es gibt noch mehr als das (wie z. B. Konsistenz der Formatierung über mehrere Geräte hinweg), aber einige der eigenwilligeren Aspekte scheinen sehr von HTML inspiriert zu sein.