Sie können verwenden pandoc auf Linux zu konvertieren Sie zwischen mehr als 40 Dateiformate. Sie können es auch verwenden, um erstellen Sie eine einfache docs-as-code-system durch das schreiben in Markdown, der Speicherung in git und publishing in einem seiner unterstützten Formate.
Konvertierung von Dokumenten und den Docs-as-Code
Wenn Sie ein Dokument in jeder von pandoc ist, viele unterstützte Dateiformate, Konvertierung in andere ist ein Kinderspiel. Das ist ein handliches Werkzeug zu haben!
Aber die wirkliche macht von pandoc wird deutlich, wenn Sie verwenden es als basis für eine einfache docs-as-code-system. Die Prämisse des docs-as-code-Einführung, die einige der Techniken und Prinzipien der software-Entwicklung und anzuwenden, um eine Dokumentation zu schreiben, besonders für die software-Entwicklung Projekte. Sie können es anwenden, um die Entwicklung irgendeiner Art von Dokumentation, obwohl.
Software-Entwickler verwenden Ihre Lieblings-editor oder integrated development environment (IDE) für das schreiben Ihrer Programme. Die code Eingabe ist gespeichert in text-Dateien. Diese enthalten den Quelltext für das Programm.
Verwenden Sie eine version control-system, oder VCS (Git am beliebtesten ist), zum erfassen von änderungen an der source-code, da es entwickelt und verbessert. Das bedeutet, der Programmierer hat eine komplette Historie aller Versionen der source-code-Dateien. Er oder Sie kann schnell auf eine beliebige frühere version einer Datei. Git speichert die Dateien in einem repository. Es gibt ein lokales repository auf jedem Entwickler-Rechner und einem zentralen, gemeinsam genutzten remote-repository, der oftmals in der cloud gehostet.
Wenn Sie bereit sind, zu produzieren, eine funktionierende version des Programms Sie verwenden einen compiler, den Quellcode zu Lesen und generieren einer ausführbaren Binärdatei.
Durch das schreiben der Dokumente in eine leichte, text-basierte markup-Sprache, die Sie verwenden können, ein VCS-version control schreiben. Wenn Sie bereit sind, zu verbreiten oder zu veröffentlichen ein Dokument, können Sie mit pandoc zu generieren, so viele verschiedene Versionen Ihrer Dokumentation, wie Sie benötigen, einschließlich web-basiert (HTML), word-Verarbeitung oder, Satz (LibreOffice, Microsoft Word, TeX), portable document format (PDF), e-book (ePub), und so weiter.
Sie können tun, all dies aus einer Reihe von-version-gesteuert, leichte text-Dateien.
Die Installation von pandoc
Installieren pandoc unter Ubuntu verwenden Sie diesen Befehl:
sudo apt-get install pandoc
Auf Fedora, der Befehl, den Sie benötigen, ist die folgende:
sudo dnf install pandoc
Auf Manjaro, die Sie brauchen zu geben:
sudo pacman -Syu pandoc
Sie können überprüfen, welche version Sie installiert haben, durch die Nutzung des –version-option:
pandoc –version
Mit pandoc Ohne Dateien
Wenn Sie verwenden pandoc ohne Befehlszeilen-Optionen akzeptiert auch getippt-Eingang. Drücken Sie einfach Strg+D, um anzuzeigen, dass Sie die Eingabe beendet haben. pandoc erwartet Sie im Markdown-format und generiert die HTML-Ausgabe.
Schauen wir uns ein Beispiel an:
pandoc
Wir getippt haben, ein paar Zeilen von Markdown und dabei sind, drücken Sie Strg+D.
Sobald wir das tun, pandoc erzeugt die entsprechende HTML-Ausgabe.
Etwas nützliches zu tun mit pandoc, obwohl wir wirklich brauchen, um Dateien verwenden.
Markdown Basics
Markdown ist eine leichte markup-Sprache, und eine Besondere Bedeutung gegeben wird, um bestimmte Zeichen. Sie können mit einem einfachen text editor erstellen, eine Markdown-Datei.
Markdown kann leicht gelesen werden, da es keine optisch schwerfällig tags ablenken vom text. Formatierung über Markdown-Dokumenten ähnelt der Formatierung, die Sie repräsentiert. Unten sind einige der Grundlagen:
- Hervorheben von text mit Kursiv, wickeln Sie es in Sternchen. *Das betont*
- Zu bold text zwei Sternchen. **Diese werden in Fettschrift**
- Überschriften sind vertreten durch die Raute/hash-Zeichen (#). Text ist getrennt von den hash durch ein Leerzeichen. Verwenden Sie einen hash für eine top-level-überschrift ” zwei für eine zweite Ebene, und so weiter.
- Erstellen einer Liste mit Aufzählungszeichen, beginnen Sie jede Zeile der Liste mit einem Sternchen und ein Leerzeichen einzufügen, bevor der text.
- Erstellen Sie eine nummerierte Liste, beginnen Sie jede Zeile mit einer Ziffer gefolgt von einem Punkt, und fügen Sie ein Leerzeichen vor dem text.
- Einen hyperlink erstellen, setzen Sie den Namen der Seite in eckige Klammern ([]), und die URL in Runden Klammern [()] so: [Link zum How-to Geek](https://www.howtogeek.com/).
- Um ein Bild einzufügen, geben Sie ein Ausrufezeichen unmittelbar vor der Klammer (![]). Geben Sie alternativen text für das Bild in die Klammern. Dann schließen Sie den Pfad zu dem Bild in Runden Klammern” ()“]. Hier ein Beispiel: .
Wir ‘ ll decken mehr Beispiele von diesen in den nächsten Abschnitt.
RELATED: Was Ist Markdown und Wie Verwenden Sie Es?
Konvertierung Von Dateien
Datei-Konvertierungen sind einfach. pandoc kann in der Regel arbeiten Sie heraus, welche Datei-Formate, die Sie arbeiten mit Ihrer Dateinamen. Hier, wir generieren eine HTML-Datei aus einer Markdown-Datei. Die Option-o (output) option sagt pandoc der name der Datei, die wir erstellen möchten:
pandoc -o sample.html Probe.md
Unser Beispiel Markdown-Datei sample.md, enthält der kurze Abschnitt von Markdown im Bild unten gezeigt.
Eine Datei namens sample.html erstellt. Wenn wir doppelklicken Sie auf die Datei, unseren Standard-browser geöffnet.
Jetzt, wir erzeugen ein “Open Document Format” text-Dokument, können wir öffnen in LibreOffice Writer:
pandoc -o sample.odt Probe.md
Die ODT-Datei hat den gleichen Inhalt wie die HTML-Datei.
Eine nette Note ist der alternative text für das Bild wird auch verwendet, um automatisch eine Beschriftung für das Bild.
Die Angabe Von Datei-Formaten
Das -f (ab) und -t (an) – Optionen werden verwendet, um zu sagen, pandoc, welche Datei-Formate die Sie konvertieren möchten, aus und um. Dies kann nützlich sein, wenn Sie arbeiten mit einer Datei-format, dass die Aktien eine Datei-Erweiterung mit anderen Formaten. Zum Beispiel, TeX und LaTeX, beide verwenden “.tex” – Erweiterung.
Wir sind auch mit der-s (standalone) – option, so pandoc wird generieren, die LaTeX-Präambel erforderlich, für ein Dokument eine vollständige, in sich geschlossene und wohlgeformten LaTeX-Dokument. Ohne-s (standalone) – option, die Ausgabe wäre immer noch gut geformt ist LaTeX, das könnte ausgebaut werden, in ein anderes LaTeX Dokument, wäre es nicht richtig analysieren als eigenständige LaTeX-Dokument.
Wir geben Sie den folgenden:
pandoc -f markdown -t latex -s -o-Probe.tex-Beispiel.md
Wenn Sie öffnen Sie die “sample.tex” – Datei in einem text-editor, sehen Sie die erzeugten LaTeX. Wenn Sie einen LaTeX-editor, öffnen Sie die TEX-Datei, um eine Vorschau, wie die LaTeX-Textsatz Befehle interpretiert werden. Verkleinern Sie die Fenster, um zu passen das Bild unten aus dem display überfüllt Aussehen, aber in Wirklichkeit war es schön.
Wir verwendeten LaTeX-editor namens Texmaker. Wenn Sie möchten, um es zu installieren in Ubuntu, geben Sie den folgenden:
sudo apt-get install texmaker
In Fedora, der Befehl ist:
sudo dnf install texmaker
In Manjaro verwenden:
sudo pacman -Syu texmaker
Konvertieren von Dateien mit Vorlagen
Wahrscheinlich sind Sie beginnen zu verstehen, die Flexibilität, die pandoc zur Verfügung stellt. Schreiben Sie einmal und veröffentlichen Sie Inhalte in nahezu jedem format. Das ist ein großes Kunststück, aber die Dokumente, die sehen ein wenig Vanille.
Mit Schablonen, die Sie diktieren können, welche Stile pandoc verwendet bei der Generierung von Dokumenten. Zum Beispiel, können Sie sagen, pandoc verwenden Sie die Stile in einer CSS (Cascading Style Sheets) Datei mit der Option –css-option.
Wir haben eine kleine CSS-Datei mit den folgenden text. Es ändert sich der Abstand oben und unterhalb der Ebene header eine style. Es ändert sich auch die Textfarbe weiß und der hintergrund-Farbe eine Schattierung von blau:
h1 {
color: #FFFFFF;
background-color: #3C33FF;
margin-top: 0px;
margin-bottom: 1px;
}
Der vollständige Befehl finden Sie unten—beachten Sie, dass wir auch die standalone-option (-s):
pandoc -o sample.html -s –Beispiel css.Beispiel css.md
pandoc benutzt die einzelnen style aus unserem minimalistischen CSS-Datei und wendet Sie auf die Ebene einer überschrift.
Ein weiteres fine-tuning-option, die Sie zur Verfügung haben, wenn die Arbeit mit HTML-Dateien enthalten HTML-markup in Ihre Markdown-Datei. Dies wird durch geführt, um die generierte HTML-Datei als standard-HTML-markup.
Diese Technik vorbehalten sein sollte, wenn man nur generieren der HTML-Ausgabe, obwohl. Wenn Sie arbeiten mit mehreren Datei-Formaten, pandoc ignorieren das HTML-markup für nicht-HTML-Dateien, und es wird übergeben werden, um diese als text.
Wir können angeben, welche Stile die verwendet werden, wenn die ODT-Dateien generiert werden, auch. Öffnen Sie ein leeres LibreOffice Writer-Dokument und passen Sie die überschrift und die schriftart-Stile, um Ihre Bedürfnisse anzupassen. In unserem Beispiel, haben wir auch Hinzugefügt eine Kopf-und Fußzeile. Speichern Sie Ihr Dokument als “odt-Vorlage.odt.”
Wir können nun diesen als Vorlage verwenden, mit der Option –reference-doc-option:
pandoc -o sample.odt –Referenz-doc=odt-Vorlage.odt Probe.md
Vergleichen Sie dies mit der ODT-Beispiel von früher. Dieses Dokument nutzt eine andere schriftart, hat farbige überschriften und beinhaltet Kopf-und Fußzeilen. Allerdings war es generiert sich aus dem exakt gleichen Muster.md” Markdown-Datei.
Referenz-Dokument-Vorlagen können verwendet werden, um die angegebenen verschiedenen Phasen der Dokumenten-Produktion. Zum Beispiel, haben Sie vielleicht Vorlagen “Entwurf” oder “Review” – Wasserzeichen. Eine Vorlage ohne Wasserzeichen verwendet werden würde für eine finalisierte Dokument.
Generieren Von PDFs
Standardmäßig pandoc verwendet das LaTeX-PDF-engine für PDF-Dateien generieren. Der einfachste Weg, um sicherzustellen, dass Sie über die entsprechenden LaTeX-Abhängigkeiten erfüllt, ist die Installation eines LaTeX-editor wie Texmaker.
Das ist eine ganz große zu installieren, obwohl Tex und LaTeX sind beide ziemlich deftig. Wenn Ihr Festplatten-Speicherplatz begrenzt ist, oder Sie wissen, dass Sie nie verwenden Sie TeX oder LaTeX, Sie bevorzugen könnte, um zu generieren, eine ODT-Datei. Dann können Sie einfach öffnen Sie es in LibreOffice Writer und speichern Sie es als PDF.
Docs-as-Code
Es gibt mehrere Vorteile der Verwendung von Markdown als Ihre Schriftsprache, einschließlich der folgenden:
- Arbeiten in nur-text-Dateien ist schnell: Sie laden schneller als vergleichbar große word-Prozessor-Dateien, und neigen dazu, sich durch die Dokumente schneller, zu. Viele Redakteure, einschließlich gedit , Vim und Emacs, verwenden Sie eine syntax-highlighting mit Markdown-text.
- Haben Sie eine Zeitleiste mit allen Versionen der Dokumente: Wenn Sie speichern Sie Ihre Unterlagen in ein VCS wie Git, Sie kann leicht sehen, die Unterschiede zwischen zwei Versionen derselben Datei. Dies kann aber nur dann wirklich funktioniert, wenn die Dateien sind plain text, wie das ist, was ein VCS erwartet, mit zu arbeiten.
- Ein VCS kann festgehalten werden, wer änderungen vorgenommen, und wenn: Das ist besonders hilfreich, wenn Sie Häufig gemeinsam mit anderen an großen Projekten. Es bietet auch eine zentrale Ablage für die Dokumente selbst. Viele cloud-gehostete Git-Dienste wie GitHub, GitLab, und BitBucket, haben freien Ebenen in Ihrer pricing-Modelle.
- Generieren Sie Ihre Dokumente in verschiedenen Formaten speichern: Mit nur ein paar einfache shell-Skripte, können Sie ziehen Sie in den Formatvorlagen aus der CSS-und Referenz-Dokumente. Wenn Sie speichern Sie Ihre Dokumente in einer VCS-repository Integration mit Continuous Integration und Continuous Deployment (CI/CD) – Plattformen, Sie können automatisch erzeugt werden, wenn die software integriert ist.
RELATED: Was Ist GitHub, und Für Was Wird Es Verwendet?
Abschließende Gedanken
Es gibt viele weitere Optionen und features in pandoc als das, was wir habe bedeckt hier. Die Umwandlung Prozesse für die meisten Dateitypen kann gezwickt werden, und fein abgestimmt. Um mehr zu erfahren, schauen Sie sich die ausgezeichneten Beispiele auf der offiziellen (und sehr detaillierte) pandoc web-Seite.
LESEN SIE WEITER
- › Wie zu Verwenden pandoc zum Konvertieren von Dateien auf der Linux-Kommandozeile
- › Wie man eine Defekte Tastatur Key auf einem Windows 10 PC
- › Wie das Ausblenden der Taskleiste auf Windows 10
- “Was Hat Apple T2 “Security Chip” in Ihrem Mac?
- “Können Sie Wirklich “Vergrößern und zu Verbessern” Sicherheit Filmmaterial?