Ein Terminalfenster, das auf einem Linux-Laptop mit einem Desktop-Design im Ubuntu-Stil ausgeführt wird.

Fatmawati Achmad Zaenuri/Shutterstock

Sie können |_+_| . verwenden unter Linux, um zwischen mehr als 40 Dateiformaten zu konvertieren. Sie können es auch verwenden, um ein einfaches Docs-as-Code-System zu erstellen, indem Sie in Markdown schreiben, in |_+_| speichern und in einem der unterstützten Formate veröffentlichen.



Dokumentenkonvertierung und Docs-as-Code

Wenn Sie ein Dokument in einem von |_+_| . haben viele unterstützte Dateiformate , die Umwandlung in einen der anderen ist ein Kinderspiel. Das ist ein praktisches Werkzeug!

Aber die wahre Macht von |_+_| wird deutlich, wenn Sie es als Basis eines einfachen Docs-as-Code-Systems verwenden. Die Prämisse von docs-as-code besteht darin, einige der Techniken und Prinzipien der Softwareentwicklung zu übernehmen und sie auf das Schreiben von Dokumentationen, insbesondere für Softwareentwicklungsprojekte, anzuwenden. Sie können es jedoch auf die Entwicklung jeder Art von Dokumentation anwenden.

Softwareentwickler verwenden ihren Lieblingseditor oder integrierte Entwicklungsumgebung (IDE), um ihre Programme zu schreiben. Der von ihnen eingegebene Code wird in Textdateien gespeichert. Diese enthalten die Quellcode für das Programm.

Sie verwenden a Versionskontrollsystem , oder VCS ( gehen ist die beliebteste), um Änderungen am Quellcode während der Entwicklung und Verbesserung zu erfassen. Dies bedeutet, dass der Programmierer über eine vollständige Historie aller Versionen der Quellcodedateien verfügt. Er oder sie kann schnell auf jede frühere Version einer Datei zugreifen. Git speichert Dateien in einem Repository. Auf dem Computer jedes Entwicklers gibt es ein lokales Repository und ein zentrales, gemeinsam genutztes Remote-Repository, das oft in der Cloud gehostet wird.

Anzeige

Wenn sie bereit sind, eine funktionierende Version des Programms zu erstellen, verwenden sie a Compiler um den Quellcode zu lesen und eine binäre ausführbare Datei zu generieren.

Indem Sie Ihre Dokumente in einer einfachen, textbasierten Auszeichnungssprache schreiben, können Sie ein VCS zur Versionskontrolle Ihres Schreibens verwenden. Wenn Sie bereit sind, ein Dokument zu verteilen oder zu veröffentlichen, können Sie |_+_| . verwenden um beliebig viele verschiedene Versionen Ihrer Dokumentation zu generieren, einschließlich webbasierter ( HTML ), Textverarbeitung oder Schriftsatz ( LibreOffice , Microsoft Word , TeX ), portables Dokumentenformat ( Pdf ), E-Book ( ePub ), und so weiter.

All dies können Sie mit einem einzigen Satz von versionierten, schlanken Textdateien erledigen.

Pandoc installieren

So installieren Sie |_+_| Verwenden Sie unter Ubuntu diesen Befehl:

pandoc

Auf Fedora benötigen Sie den folgenden Befehl:

git

Auf Manjaro müssen Sie Folgendes eingeben:

pandoc's

Sie können überprüfen, welche Version Sie installiert haben, indem Sie |_+_| . verwenden Möglichkeit:

pandoc

So finden Sie das Internet-Passwort

pandoc ohne Dateien verwenden

Wenn Sie |_+_| . verwenden ohne Befehlszeilenoptionen akzeptiert es auch eingegebene Eingaben. Drücken Sie einfach Strg+D, um anzuzeigen, dass Sie mit der Eingabe fertig sind. |_+_| erwartet, dass Sie im Markdown-Format eingeben, und generiert eine HTML-Ausgabe.

Schauen wir uns ein Beispiel an:

pandoc

Wir haben ein paar Zeilen Markdown eingegeben und sind dabei, Strg+D zu drücken.

vlc rippt dvd in mp4

Anzeige

Sobald wir das tun, |_+_| erzeugt die entsprechende HTML-Ausgabe.

Um mit |_+_| etwas Nützliches zu tun, müssen wir jedoch wirklich Dateien verwenden.

Markdown-Grundlagen

Markdown ist eine leichtgewichtige Auszeichnungssprache, und bestimmten Zeichen wird eine besondere Bedeutung beigemessen. Sie können einen Nur-Text-Editor verwenden, um eine Markdown-Datei zu erstellen.

Markdown lässt sich gut ablesen, da keine optisch störenden Tags vom Text ablenken. Die Formatierung in Markdown-Dokumenten ähnelt der Formatierung, die sie darstellen. Im Folgenden sind einige der Grundlagen aufgeführt:

  • Text hervorheben mit Kursivschrift , wickeln Sie es in Sternchen ein. |_+_|
  • Zu deutlich Text, verwenden Sie zwei Sternchen. |_+_|
  • Überschriften werden durch das Nummernzeichen/Hash-Zeichen (|_+_|) dargestellt. Der Text wird durch ein Leerzeichen vom Raute getrennt. Verwenden Sie einen Hash für eine Überschrift der obersten Ebene, zwei für eine Überschrift der zweiten Ebene und so weiter.
  • Um eine Liste mit Aufzählungszeichen zu erstellen, beginnen Sie jede Zeile der Liste mit einem Sternchen und fügen Sie vor dem Text ein Leerzeichen ein.
  • Um eine nummerierte Liste zu erstellen, beginnen Sie jede Zeile mit einer Ziffer gefolgt von einem Punkt und fügen Sie dann vor dem Text ein Leerzeichen ein.
  • Um einen Hyperlink zu erstellen, schließen Sie den Namen der Site in eckige Klammern (|_+_|) und die URL in Klammern [|_+_|] wie folgt ein: |_+_|.
  • Um ein Bild einzufügen, geben Sie ein Ausrufezeichen direkt vor Klammern (|_+_|) ein. Geben Sie einen beliebigen alternativen Text für das Bild in die Klammern ein. Schließen Sie dann den Pfad zum Bild in Klammern ein [|_+_|]. Hier ist ein Beispiel: |_+_|.

Wir werden im nächsten Abschnitt weitere Beispiele für all dies behandeln.

VERBUNDEN: Was ist Markdown und wie wird es verwendet?

Konvertieren von Dateien

Dateikonvertierungen sind unkompliziert. |_+_| können normalerweise anhand der Dateinamen erkennen, mit welchen Dateiformaten Sie arbeiten. Hier generieren wir eine HTML-Datei aus einer Markdown-Datei. Die |_+_| (Ausgabe) Option sagt |_+_| der Name der Datei, die wir erstellen möchten:

pandoc

Anzeige

Unsere Beispiel-Markdown-Datei sample.md enthält den kurzen Abschnitt von Markdown, der in der Abbildung unten gezeigt wird.

Markdown-Text in der Datei sample.md in einem gedit-Editorfenster.

Eine Datei namens sample.html wird erstellt. Wenn wir auf die Datei doppelklicken, öffnet unser Standardbrowser sie.

HTML-Rendering der Markdown-Datei sample.md in einem Browserfenster.

Lassen Sie uns nun ein generieren Dokumentformat öffnen Textdokument, in dem wir öffnen können LibreOffice-Autor :

--version

Die ODT-Datei hat denselben Inhalt wie die HTML-Datei.

Ein aus Markdown gerendertes und in LibreOffice Writer geöffnetes ODT-Dokument.

Eine nette Geste ist, dass der alternative Text für das Bild auch verwendet wird, um automatisch eine Bildunterschrift für die Abbildung zu generieren.

Eine automatisch generierte Bildunterschrift in LibreOffice Writer.

cbs all access abonnement kündigen

Dateiformate angeben

Die |_+_| (von) und |_+_| (to)-Optionen werden verwendet, um |_+_| . mitzuteilen in welche Dateiformate Sie konvertieren möchten. Dies kann nützlich sein, wenn Sie mit einem Dateiformat arbeiten, das eine Dateierweiterung mit anderen verwandten Formaten teilt. Beispielsweise, TeX , und Latex beide verwenden die Erweiterung .tex.

Wir verwenden auch die |_+_| (eigenständige) Option, also |_+_| generiert alle LaTeX-Präambeln, die für ein Dokument erforderlich sind, um ein vollständiges, in sich geschlossenes und wohlgeformtes LaTeX-Dokument zu sein. Ohne die |_+_| (Standalone) Option wäre die Ausgabe immer noch wohlgeformtes LaTeX, das in ein anderes LaTeX-Dokument eingefügt werden könnte, es würde nicht richtig als eigenständiges LaTeX-Dokument geparst.

Wir geben folgendes ein:

pandoc

Anzeige

Wenn Sie die Datei sample.tex in einem Texteditor öffnen, sehen Sie das generierte LaTeX. Wenn Sie einen LaTeX-Editor haben, können Sie die TEX-Datei öffnen, um eine Vorschau der Interpretation der LaTeX-Satzbefehle anzuzeigen. Durch das Verkleinern des Fensters, um es in das Bild unten einzupassen, sah das Display beengt aus, aber in Wirklichkeit war es in Ordnung.

Eine in Texmaker geöffnete LaTeX-Datei, die eine Vorschau der Satzseite anzeigt.

Wir haben einen LaTeX-Editor namens . verwendet Texmaker . Wenn Sie es in Ubuntu installieren möchten, geben Sie Folgendes ein:

pandoc

In Fedora lautet der Befehl:

pandoc

Verwenden Sie in Manjaro:

pandoc

Konvertieren von Dateien mit Vorlagen

Sie beginnen wahrscheinlich die Flexibilität zu verstehen, die |_+_| bietet. Sie können einmal schreiben und in fast jedem Format veröffentlichen. Das ist eine großartige Leistung, aber die Dokumente sehen ein wenig nach Vanille aus.

Mit Vorlagen können Sie bestimmen, welche Stile |_+_| verwendet, wenn es Dokumente generiert. Zum Beispiel kannst du |_+_| . sagen um die in a . definierten Stile zu verwenden Cascading Style Sheets (CSS) Datei mit dem |_+_| Möglichkeit.

Wir haben eine kleine CSS-Datei erstellt, die den folgenden Text enthält. Es ändert den Abstand über und unter der Ebenenüberschrift um einen Stil. Es ändert auch die Textfarbe in Weiß und die Hintergrundfarbe in einen Blauton:

*This will be emphasized*

Den vollständigen Befehl finden Sie unten – beachten Sie, dass wir auch die eigenständige Option (|_+_|) verwendet haben:

**This will be in bold**Anzeige

|_+_| verwendet den einzelnen Stil aus unserer minimalistischen CSS-Datei und wendet ihn auf den Header der ersten Ebene an.

Aus Markdown gerendertes HTML mit einem CSS-Stil, der auf die Überschrift der ersten Ebene in einem Browserfenster angewendet wird

Eine weitere Feinabstimmungsoption, die Ihnen beim Arbeiten mit HTML-Dateien zur Verfügung steht, besteht darin, HTML-Markup in Ihre Markdown-Datei aufzunehmen. Diese wird als Standard-HTML-Markup an die generierte HTML-Datei übergeben.

Diese Technik sollte jedoch reserviert werden, wenn Sie nur HTML-Ausgaben generieren. Wenn Sie mit mehreren Dateiformaten arbeiten, |_+_| ignoriert das HTML-Markup für Nicht-HTML-Dateien und wird als Text an diese weitergegeben.

Wir können auch festlegen, welche Stile beim Generieren von ODT-Dateien verwendet werden. Öffnen Sie ein leeres LibreOffice Writer-Dokument und passen Sie die Überschriften- und Schriftstile an Ihre Bedürfnisse an. In unserem Beispiel haben wir auch eine Kopf- und Fußzeile hinzugefügt. Speichern Sie Ihr Dokument als odt-template.odt.

Wir können dies jetzt als Vorlage mit dem |_+_| . verwenden Möglichkeit:

#

Vergleichen Sie dies mit dem ODT-Beispiel von früher. Dieses Dokument verwendet eine andere Schriftart, hat farbige Überschriften und enthält Kopf- und Fußzeilen. Es wurde jedoch aus genau der gleichen sample.md Markdown-Datei generiert.

Eine aus Markdown gerenderte ODT-Datei mit einem als Stylesheet fungierenden LibreOffice-Dokument in einem LibreOffice Writer-Fenster.

checkliste in google docs erstellen
Anzeige

Referenzdokumentvorlagen können verwendet werden, um verschiedene Phasen der Dokumenterstellung anzugeben. Beispielsweise könnten Sie über Vorlagen verfügen, die über Entwurfs- oder Zur Überprüfung-Wasserzeichen verfügen. Für ein fertiges Dokument wird eine Vorlage ohne Wasserzeichen verwendet.

PDFs erstellen

Standardmäßig ist |_+_| verwendet die LaTeX PDF-Engine zum Generieren von PDF-Dateien. Der einfachste Weg, um sicherzustellen, dass die entsprechenden LaTeX-Abhängigkeiten erfüllt sind, besteht darin, einen LaTeX-Editor wie Texmaker zu installieren.

Das ist jedoch eine ziemlich große Installation – Tex und LaTeX sind beide ziemlich umfangreich. Wenn Ihr Festplattenspeicher begrenzt ist oder Sie wissen, dass Sie TeX oder LaTeX nie verwenden werden, ziehen Sie es vielleicht vor, eine ODT-Datei zu generieren. Dann können Sie es einfach in LibreOffice Writer öffnen und als PDF speichern.

Docs-as-Code

Die Verwendung von Markdown als Schreibsprache bietet mehrere Vorteile, darunter die folgenden:

    Das Arbeiten in Nur-Text-Dateien ist schnell:Sie werden schneller geladen als Textverarbeitungsdateien ähnlicher Größe und neigen dazu, sich auch schneller durch das Dokument zu bewegen. Viele Herausgeber, darunter |_+_| , |_+_| , und |_+_| verwenden Syntaxhervorhebung mit Markdown-Text. Sie haben eine Zeitleiste aller Versionen Ihrer Dokumente:Wenn Sie Ihre Dokumentation in einem VCS wie Git speichern, können Sie die Unterschiede zwischen zwei beliebigen Versionen derselben Datei leicht erkennen. Dies funktioniert jedoch nur dann wirklich, wenn es sich bei den Dateien um Klartext handelt, da ein VCS damit zu arbeiten erwartet. Ein VCS kann aufzeichnen, wer wann Änderungen vorgenommen hat:Dies ist besonders hilfreich, wenn Sie häufig mit anderen an großen Projekten zusammenarbeiten. Es bietet auch eine zentrale Ablage für die Dokumente selbst. Viele Cloud-gehostete Git-Dienste wie GitHub , GitLab , und Bit Bucket , haben kostenlose Stufen in ihren Preismodellen. Sie können Ihre Dokumente in mehreren Formaten generieren:Mit nur ein paar einfachen Shell-Skripten können Sie die Stile aus CSS und Referenzdokumenten abrufen. Wenn Sie Ihre Dokumente in einem VCS-Repository speichern, das in Kontinuierliche Integration und kontinuierliche Bereitstellung (CI/CD)-Plattformen können sie automatisch generiert werden, wenn die Software erstellt wird.

VERBUNDEN: Was ist GitHub und wofür wird es verwendet?

Abschließende Gedanken

Es gibt viele weitere Optionen und Funktionen in pandoc als das, was wir hier behandelt haben. Die Konvertierungsprozesse für die meisten Dateitypen können optimiert und verfeinert werden. Um mehr zu erfahren, sehen Sie sich die hervorragenden Beispiele im offiziellen (und äußerst detaillierten) Pandoc-Webseite .

Linux-Befehle
Dateien Teer · pv · Katze · tac · chmod · Griff · unterschied · sed · Mit · Mann · geschoben · popd · fsck · Testdisk · seq · fd · pandoc · CD · $PFAD · awk · beitreten · jq · falten · einzigartig · Journalctl · Schwanz · Zustand · ls · fstab · rauswerfen · weniger · chgrp · chown · rev · suchen · Saiten · Typ · umbenennen · Postleitzahl · entpacken · montieren · ummount · Installieren · fdisk · mkfs · rm · rmdir · rsync · df · gpg · wir · Nano · mkdir · von · ln · Patch · Konvertieren · rclon · Fetzen · SRM
Prozesse alias · Bildschirm · oben · nett · renice · Fortschritt · strace · System · tmux · chsh · Geschichte · beim · Charge · kostenlos · die · dmesg · Benutzermod · ps · chroot · xargs · tty · kleiner Finger · lsof · vmstat · Auszeit · Mauer · ja · töten · Schlaf · sudo · seine · Zeit · groupadd · Benutzermod · Gruppen · lshw · stilllegen · neu starten · halt · ausschalten · passwd · lscpu · crontab · Datum · bg · fg
Vernetzung netstat · Klingeln · Traceroute · ip · ss · Wer ist · fail2ban · bmon · Sie · Finger · nmap · ftp · Locken · wget · Wer · Wer bin ich · In · iptables · ssh-keygen · ufw

VERBUNDEN: Beste Linux-Laptops für Entwickler und Enthusiasten

WEITER LESEN