Connect with us

Wie man

So verwenden Sie pandoc zum Konvertieren von Dateien in der Linux-Befehlszeile

So verwenden Sie Curl zum Herunterladen von Dateien über die Linux-Befehlszeile

Fatmawati Achmad Zaenuri / Shutterstock

Sie können verwenden pandoc unter Linux zum Konvertieren zwischen mehr als 40 Dateiformaten. Sie können es auch verwenden, um ein einfaches Dokument-als-Code-System zu erstellen, indem Sie in Markdown schreiben und darin speichern gitund Veröffentlichung in einem der unterstützten Formate.

Dokumentkonvertierung und Docs-as-Code

Wenn Sie ein Dokument in einem von haben pandoc's viele unterstützte DateiformateEs ist ein Kinderspiel, es in eines der anderen umzuwandeln. Das ist ein praktisches Werkzeug!

Aber die wahre Kraft von pandoc wird deutlich, wenn Sie es als Grundlage für ein einfaches Docs-as-Code-System 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 Dokumentation anzuwenden, insbesondere für Softwareentwicklungsprojekte. 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 benutzen a Versionskontrollsystemoder VCS (Git ist am beliebtesten), um Änderungen am Quellcode zu erfassen, während dieser entwickelt und erweitert wird. Dies bedeutet, dass der Programmierer einen vollständigen Verlauf aller Versionen der Quellcodedateien hat. 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 häufig in der Cloud gehostet wird.

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

Indem Sie Ihre Dokumente in einer einfachen, textbasierten Auszeichnungssprache schreiben, können Sie ein VCS verwenden, um die Versionskontrolle Ihres Schreibens zu verwenden. Wenn Sie bereit sind, ein Dokument zu verteilen oder zu veröffentlichen, können Sie es verwenden pandoc um so viele verschiedene Versionen Ihrer Dokumentation zu generieren, wie Sie benötigen, einschließlich webbasierter (HTML), Textverarbeitung oder Satz (LibreOffice, Microsoft Word, TeX), tragbares Dokumentformat (PDF), E-Book (ePub), usw.

All dies können Sie aus einem Satz versionierter, leichtgewichtiger Textdateien heraus tun.

Pandoc installieren

Installieren pandoc Verwenden Sie unter Ubuntu diesen Befehl:

sudo apt-get install pandoc

Unter Fedora benötigen Sie den folgenden Befehl:

sudo dnf install pandoc

Auf Manjaro müssen Sie Folgendes eingeben:

sudo pacman -Syu pandoc

Sie können überprüfen, welche Version Sie installiert haben, indem Sie die --version Möglichkeit:

pandoc --version

Pandoc ohne Dateien verwenden

Wenn du benutzt pandoc Ohne Befehlszeilenoptionen werden auch eingegebene Eingaben akzeptiert. Sie drücken einfach Strg + D, um anzuzeigen, dass Sie mit der Eingabe fertig sind. pandoc erwartet, dass Sie das Markdown-Format eingeben, und es 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.

Sobald wir es tun, pandoc generiert die entsprechende HTML-Ausgabe.

Um irgendetwas Nützliches zu tun pandocWir müssen jedoch wirklich Dateien verwenden.

Markdown-Grundlagen

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

Markdown kann leicht gelesen werden, da es keine visuell umständlichen Tags gibt, die vom Text ablenken könnten. Die Formatierung in Markdown-Dokumenten ähnelt der Formatierung, die sie darstellt. Im Folgenden sind einige der Grundlagen aufgeführt:

  • Um Text hervorzuheben, wickeln Sie ihn in Sternchen ein. *This will be emphasized*
  • Zu Fett gedruckt Text, verwenden Sie zwei Sternchen. **This will be in bold**
  • Überschriften werden durch das Nummernzeichen / Rautezeichen (#). Text ist durch ein Leerzeichen vom Hash getrennt. Verwenden Sie einen Hash für eine Überschrift der obersten Ebene, zwei für eine Überschrift der zweiten Ebene usw.
  • Um eine Liste mit Aufzählungszeichen zu erstellen, beginnen Sie jede Zeile der Liste mit einem Sternchen und fügen Sie ein Leerzeichen vor dem Text ein.
  • Um eine nummerierte Liste zu erstellen, beginnen Sie jede Zeile mit einer Ziffer gefolgt von einem Punkt und fügen Sie dann ein Leerzeichen vor dem Text ein.
  • Um einen Hyperlink zu erstellen, setzen Sie den Namen der Site in eckige Klammern ([]) und die URL in Klammern [()] wie so: [Link to How to Geek](https://www.howtogeek.com/).
  • Geben Sie zum Einfügen eines Bildes unmittelbar vor den Klammern ein Ausrufezeichen ein (![]). Geben Sie einen alternativen Text für das Bild in die Klammern ein. Fügen Sie dann den Pfad zum Bild in Klammern ein [()“]. Hier ist ein Beispiel: ![The Geek](HTG.png).

Weitere Beispiele für all dies werden wir im nächsten Abschnitt behandeln.

Dateien konvertieren

Dateikonvertierungen sind unkompliziert. pandoc Normalerweise können Sie anhand der Dateinamen herausfinden, mit welchen Dateiformaten Sie arbeiten. Hier generieren wir eine HTML-Datei aus einer Markdown-Datei. Das -o (Ausgabe) Option sagt pandoc Der Name der Datei, die wir erstellen möchten:

pandoc -o sample.html sample.md

Unsere Beispiel-Markdown-Datei sample.md enthält den im Abschnitt unten gezeigten kurzen Abschnitt von Markdown.

Markieren Sie den Text in der Datei sample.md in einem gedit-Editorfenster.

Eine Datei mit dem Namen sample.html wird erstellt. Wenn wir auf die Datei doppelklicken, wird sie von unserem Standardbrowser geöffnet.

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

Lassen Sie uns nun eine generieren Öffnen Sie das Dokumentformat Textdokument, in dem wir öffnen können LibreOffice Writer::

pandoc -o sample.odt sample.md

Die ODT-Datei hat den gleichen Inhalt wie die HTML-Datei.

Ein ODT-Dokument, das aus dem Abschlag gerendert und in LibreOffice Writer geöffnet wurde.

Eine nette Berührung ist der alternative Text für das Bild, der auch verwendet wird, um automatisch eine Beschriftung für die Figur zu generieren.

Eine automatisch generierte Bildunterschrift in LibreOffice Writer.

Angeben von Dateiformaten

Das -f (von) und -t (zu) Optionen werden verwendet, um zu sagen pandoc Welche Dateiformate möchten Sie konvertieren? Dies kann nützlich sein, wenn Sie mit einem Dateiformat arbeiten, das eine Dateierweiterung mit anderen verwandten Formaten gemeinsam nutzt. Zum Beispiel, TeX, und Latex Beide verwenden die Erweiterung „.tex“.

Wir benutzen auch die -s (Standalone) Option also pandoc generiert die gesamte LaTeX-Präambel, die erforderlich ist, damit ein Dokument ein vollständiges, in sich geschlossenes und wohlgeformtes LaTeX-Dokument ist. Ohne das -s (Standalone-) Option, die Ausgabe wäre immer noch wohlgeformtes LaTeX, das in ein anderes LaTeX-Dokument eingefügt werden könnte. Es würde nicht ordnungsgemäß als eigenständiges LaTeX-Dokument analysiert.

Wir geben Folgendes ein:

pandoc -f markdown -t latex -s -o sample.tex sample.md

Wenn Sie die Datei «sample.tex» in einem Texteditor öffnen, wird das generierte LaTeX angezeigt. Wenn Sie über einen LaTeX-Editor verfügen, können Sie die TEX-Datei öffnen, um eine Vorschau der Interpretation der LaTeX-Satzbefehle anzuzeigen. Wenn Sie das Fenster verkleinern, um es an das Bild unten anzupassen, sah das Display eng aus, aber in Wirklichkeit war es in Ordnung.

Eine in Texmaker geöffnete LaTeX-Datei mit einer Vorschau der gesetzten Seite.

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

sudo apt-get install texmaker

In Fedora lautet der Befehl:

sudo dnf install texmaker

Verwenden Sie in Manjaro:

sudo pacman -Syu texmaker

Konvertieren von Dateien mit Vorlagen

Sie beginnen wahrscheinlich, die Flexibilität zu verstehen, die pandoc 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 vanillig aus.

Mit Vorlagen können Sie festlegen, welche Stile verwendet werden sollen pandoc wird verwendet, wenn Dokumente generiert werden. Zum Beispiel können Sie sagen pandoc um die in a definierten Stile zu verwenden Cascading Style Sheets (CSS) Datei mit dem --css Möglichkeit.

Wir haben eine kleine CSS-Datei erstellt, die den folgenden Text enthält. Es ändert den Abstand über und unter dem Level-Header um einen Stil. Außerdem wird die Textfarbe in Weiß und die Hintergrundfarbe in einen Blauton geändert:

h1 {
  color: #FFFFFF;
  background-color: #3C33FF;
  margin-top: 0px;
  margin-bottom: 1px;
}

Der vollständige Befehl finden Sie weiter unten. Beachten Sie, dass wir auch die Standalone-Option verwendet haben (-s):

pandoc -o sample.html -s --css sample.css sample.md

pandoc Verwendet den einzelnen Stil aus unserer minimalistischen CSS-Datei und wendet ihn auf den Header der Ebene 1 an.

Aus Markdown gerenderter HTML-Code mit einem CSS-Stil, der in einem Browserfenster auf die Überschrift der Ebene 1 angewendet wird

Eine weitere Option zur Feinabstimmung, die Sie bei der Arbeit mit HTML-Dateien zur Verfügung haben, besteht darin, HTML-Markup in Ihre Markdown-Datei aufzunehmen. Dies wird als Standard-HTML-Markup an die generierte HTML-Datei weitergeleitet.

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

Wir können angeben, welche Stile auch beim Generieren von ODT-Dateien verwendet werden. Öffnen Sie ein leeres LibreOffice Writer-Dokument und passen Sie die Überschrift und die Schriftstile an Ihre Anforderungen 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 --reference-doc Möglichkeit:

pandoc -o sample.odt --reference-doc=odt-template.odt sample.md

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 derselben Markdown-Datei «sample.md» generiert.

Eine ODT-Datei, die aus einem Markdown mit einem LibreOffice-Dokument gerendert wurde, das als Stylesheet in einem LibreOffice Writer-Fenster fungiert.

Referenzdokumentvorlagen können verwendet werden, um verschiedene Phasen der Dokumentproduktion anzuzeigen. Beispielsweise haben Sie möglicherweise Vorlagen mit Wasserzeichen «Entwurf» oder «Zur Überprüfung». Eine Vorlage ohne Wasserzeichen würde für ein finalisiertes Dokument verwendet.

PDFs generieren

Standardmäßig, pandoc 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 allerdings eine ziemlich große Installation – Tex und LaTeX sind beide ziemlich umfangreich. Wenn Ihr Festplattenspeicher begrenzt ist oder Sie wissen, dass Sie niemals TeX oder LaTeX verwenden, ziehen Sie es möglicherweise vor, eine ODT-Datei zu generieren. Anschließend 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 bewegen sich auch schneller durch das Dokument. Viele Redakteure, darunter gedit , Vim , und EmacsVerwenden Sie die 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 einfachen Text handelt, da dies von einem VCS erwartet wird.
  • Ein VCS kann aufzeichnen, wer wann Änderungen vorgenommen hat: Dies ist besonders hilfreich, wenn Sie bei großen Projekten häufig mit anderen zusammenarbeiten. Es bietet auch ein zentrales Repository für die Dokumente selbst. Viele in der Cloud gehostete Git-Dienste wie GitHub, GitLab, und Bit Buckethaben freie Stufen in ihren Preismodellen.
  • Sie können Ihre Dokumente in mehreren Formaten erstellen: 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 integriert ist Kontinuierliche Integration und kontinuierliche Bereitstellung (CI / CD) -Plattformen können automatisch generiert werden, wenn die Software erstellt wird.

Abschließende Gedanken

Es gibt viele weitere Optionen und Funktionen pandoc als das, was wir hier behandelt haben. Die Konvertierungsprozesse für die meisten Dateitypen können optimiert und optimiert werden. Weitere Informationen finden Sie in den hervorragenden Beispielen des offiziellen (und äußerst detaillierten) Beispiels. Pandoc-Webseite.

Continue Reading
Click to comment

Leave a Reply

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

Tendencia