Abschlag

Guten Tag, Kollegen! Nach einer langen Lernreise möchte doch jeder dem Arbeitgeber seine Früchte zeigen, und zwar nur von der besten, professionellen Seite, oder? Ich denke ja. Daher müssen wir neben einem korrekt konzipierten und umgesetzten Projekt auch in der Lage sein, es zu formalisieren. Der Arbeitgeber liest nicht Ihren gesamten Projektcode, um zu verstehen, worum es darin geht und was darin enthalten ist? In diesem Artikel werden wir abschließend die beiden vorherigen zusammenfassen, nämlich „ Continuous Integration “ und „Code Coverage “, und uns auf der „Vorderseite“ des Open-Source-Projekts erklären, was wir in unserem Projekt verwendet haben und was es darstellt. Heute werden wir mit Ihnen über Markdown sprechen und unsere Lieblingsfragen stellen: „Was ist das?“ und „Warum ist das so?“, wollen wir herausfinden, wo es verwendet wird und wie man damit arbeitet. Es wird sogar ein Beispiel geben, wir werden es in unserem Open-Source-Projekt implementieren . So lass uns gehen!

Was ist „Markdown“?

Da Sie und ich Programmierer sind, gehen wir sofort zu Google und öffnen den ersten Wiki- Link , der besagt: Markdown ist eine leichte Auszeichnungssprache, die mit dem Ziel erstellt wurde, den am besten lesbaren und am einfachsten zu bearbeitenden Text zu schreiben, der aber für geeignet ist Konvertierung in Sprachen für fortgeschrittene Veröffentlichungen (HTML, Rich Text und andere). Um ehrlich zu sein, habe ich hier nicht viel hinzuzufügen, ich denke, das ist eine nahezu perfekte Erklärung.

Warum brauchen wir diesen „Markdown“?

Um ehrlich zu sein, ist es ohne eigentlich nicht schlecht :D Aber erinnern wir uns an unser Ziel: eine kompetente Projektvorlage zu schreiben, die bereits über Continuous Integration verfügt und über Code-Coverage-Statistiken auf der Codecov-Ressource verfügt. Warum habe ich das erwähnt? Darüber hinaus ermöglicht uns Markdown, Daten aus diesen Ressourcen zu entnehmen und die Daten selbst oder Badges bereitzustellen, die uns dorthin weiterleiten, wo wir diese Informationen benötigen. Es ist praktisch, alles auf einer „Titelseite“ zu haben, anstatt es an verschiedenen Orten zu verstreuen, nicht wahr?

Wo wird es verwendet?

Jeder, der schon einmal eines seiner Projekte auf GitHub hochgeladen hat, weiß, dass GitHub Sie ständig dazu einladen möchte, eine README-Datei zu erstellen: Welche Erweiterung hat diese Datei? Genau, Bolt kennt Markdown! Wie wir bereits wissen, lässt sich diese Datei sehr einfach an viele Formate anpassen und in das von uns benötigte HTML konvertieren. Aber nehmen wir uns Zeit und fügen es nicht sofort direkt zu GitHub hinzu.

Wie arbeitet man damit?

Erstens können wir es, wie Sie vielleicht bemerkt haben, direkt zu GitHub hinzufügen und es wird funktionieren! Aber wir müssen es beispielsweise nicht immer nur einem Projekt hinzufügen. Oder wir möchten zum Beispiel mehr darüber nachdenken, wie wir es schaffen. Und hier ist GitHub für uns nicht mehr geeignet. Und im Allgemeinen können wir Markdown-Dateien nicht nur erstellen, um sie auf GitHub zu übertragen. Zweitens könnten wir es direkt über IDEA erstellen, was genau das ist, was wir tun werden, aber nicht sofort, denn warum brauchen wir eine leistungsstarke Entwicklungsumgebung, um eine kleine Datei zu schreiben? Hier empfehle ich, den Katalog der einfachen und nicht so einfachen Markdown-Dateieditoren zu durchsuchen. Für mich selbst habe ich mich für Haroopad entschieden , es ist sehr einfach, zugänglich, bietet eine sofortige Darstellung dessen, was Sie schreiben (IDEA tut das auch) und hat einen Syntaxhinweis. So sieht das Editorfenster aus: Hier habe ich eine fertige README.md eines meiner Projekte geöffnet. Links ist ein Spickzettel, rechts eine Anzeige, in der Mitte Text. Alles ist sehr primitiv und einfach. Sie können auch Abzeichen sehen, über die wir gleich sprechen werden. Diejenigen, die sich für eine andere Art des Schreibens dieser Dateien entscheiden – seien Sie nicht beunruhigt, alles, was anders sein wird, ist die grafische Oberfläche. Text, Syntax und Darstellung bleiben unverändert. Beispiel Die Aufgabe ist sehr einfach: Schreiben Sie README.md so, dass es Folgendes enthält: Informationen zum Projekt (einschließlich Abzeichen), Informationen zum Importieren des Projekts, Informationen zur Implementierung des Projekts, Informationen zu den Kontakten des Autors. Alles ist sehr einfach und primitiv, wie ich bereits sagte. Kommen wir zur Sache.

1. Schreiben wir einen Titel – den Namen unseres Projekts.

   Mit dem Hash-Operator „ # “ wird die Haupt- und größte Überschrift erstellt und anschließend der Titel geschrieben. In unserem Fall:

   # ForJavaRushPublication

2. Dann schreiben wir einen etwas kleineren Titel und schreiben „Projektinformationen“. Dem kleineren Header wird mehr „ # “ vorangestellt :

   ## Information

   Und dann werden wir Informationen über das Projekt schreiben.

3. Lassen Sie uns Links zu unseren Artikeln einfügen. Das geht ganz einfach, und wenn Sie Haroopad verwenden, geben Sie einfach den Spickzettel ein und die Vorlage wird automatisch eingefügt. Die Syntax lautet: „ [text](url) “;

4. Lassen Sie uns Abzeichen einfügen. Schauen wir hier genauer hin.

   Der Schönheit halber ordnen wir sie zunächst in Form eines Tisches an. Es wird 2 Spalten und 2 Spalten geben. Die Syntax sieht etwa so aus:

   Und das Ergebnis wird so sein:

   Als nächstes fügen wir Hyperlinks zu unseren Abzeichen ein, aber wo können wir sie bekommen? Ich habe im vorherigen Artikel gezeigt, wo man Codecov bekommt, aber ich habe nicht erwähnt, welches man bekommen soll. Da wir eine Markdown-Datei haben, benötigen wir auch ein Markdown-Badge:

   Kopieren Sie es einfach und fügen Sie es in eine Spalte in unserem Markdown ein. Vergessen Sie jedoch nicht, dass Codecov im JaCoCo-Zweig angezeigt wird, nicht jedoch im Master. Sie müssen ihn also manuell korrigieren. Das Travis CI-Abzeichen steht direkt gegenüber dem Projektnamen, wo das Build-Protokoll lautet:

   Wir wählen das Abzeichen aus und dann erscheint das Einstellungsfenster:

   Wir wählen auf jeden Fall Markdown und den Zweig aus, den Sie benötigen. Ich werde README.md für zwei Zweige erstellen und sie werden etwas unterschiedlich sein, da ich Codecov noch nicht im Hauptzweig implementiert habe.




5. Schreiben wir Informationen zum Importieren oder Klonen dieses Projekts. Ich werde nicht erklären, wie das geht, aber Sie können es in meiner README.md lesen. Wir werden über die Technologien schreiben, die wir in unserem Projekt verwendet haben, und Links zu ihnen platzieren. Dennoch handelt es sich um ein Bildungsprojekt. Nun, schreiben wir uns die Kontaktinformationen auf.




6. Unser Markdown ist fertig. Wir müssen es nur noch unserem Projekt hinzufügen und schon sind wir fertig. Aber nicht alles auf einmal! Öffnen wir unsere IDEA und prüfen in den Plugins, ob Sie Markdown-Unterstützung haben:

   Ich habe Ultimate IDEA, also habe ich alles, Ihr Plugin ist möglicherweise nicht standardmäßig installiert, aber wenn Sie eine Datei mit der Erweiterung md erstellen, sollten Sie aufgefordert werden, sie herunterzuladen. Laden Sie Ihre IDEA herunter und starten Sie sie neu.




7. Nachdem Sie den von uns geschriebenen Markdown importiert haben, öffnen Sie ihn über IDEA und bearbeiten Sie ihn bei Bedarf. So sieht es über IDEA aus:

   Wir machen Druck. Dann sehen wir, dass beim Öffnen eines Projekts sofort Informationen darüber geladen werden, dies ist unsere README.md:

   Wenn wir nun auf das Abzeichen klicken, können wir direkt zur Projektmontage springen und sehen, was wir dort haben und wie.




8. Ich werde das Gleiche für den JaCoCo-Zweig tun, um Codecov Badge zu demonstrieren, da wir README.md noch nicht darin haben. Daher haben wir jetzt zwei Abzeichen:

   Codecov zeigt den Prozentsatz der Codeabdeckung an und kann uns auch zur Codecov-Seite weiterleiten und einen detaillierten Bericht zur Codeabdeckung anzeigen.

Nützliche Links

• Was uns Wiki über Markdown erzählt;
• Verzeichnis der Markdown-Editoren ;
• Haroopad, das ich empfehle;
• Über Markdown auf der JetBrains- Website ;
• Markdown Navigator auf demselben JetBrains;
• Abzeichen und alles darüber. Hier können Sie den Stil jedes Abzeichens auswählen und es individuell anpassen.
• Wie aktualisieren Sie Ihr Open-Source-Projekt? Dieser Artikel wird auch antworten ;
• Vorheriger Artikel

Fassen wir die Reihe meiner Artikel zusammen

1. Im ersten Artikel über Continuous Integration haben wir uns angeschaut, was CI ist, wozu es dient und wie man es nutzt .
2. Wir haben mit CC herumgespielt und im zweiten Artikel über Code Coverage verstanden, was es ist und warum es benötigt wird .
3. Und in diesem Artikel haben wir untersucht, was Markdown ist, warum es benötigt wird und wie man es effektiv nutzt.

Vielen Dank, dass Sie diese drei langen Artikel gelesen haben. Ich hoffe, sie waren nützlich. Der Text kann Fehler und Auslassungen enthalten. Vielen Dank für Ihre Aufmerksamkeit!