U kunt gebruik maken van pandoc op Linux te zetten tussen meer dan 40 bestandsformaten. U kunt het ook gebruiken voor het maken van een eenvoudige documenten-zoals-het systeem van de code door te schrijven in de Markdown, opslaan in git, en het publiceren in een van de ondersteunde indelingen.
Document Conversie en google Documenten-als-Code
Als u een document in een van pandoc is een van de vele ondersteunde bestandsformaten converteren naar een van de anderen is het een fluitje van een cent. Dat is een handige tool om te hebben!
Maar de echte kracht van pandoc wordt duidelijk wanneer u dit als de basis van een eenvoudige documenten-zoals-het systeem van de code. Het uitgangspunt van documenten-zoals-code is te nemen een aantal van de technieken en principes van de ontwikkeling van software en toepassen bij het schrijven van de documentatie, in het bijzonder voor de ontwikkeling van software projecten. U kunt het toepassen op de ontwikkeling van enige vorm van documentatie, dat wel.
Software-ontwikkelaars gebruiken hun favoriete editor of IDE (integrated development environment) voor het schrijven van hun programma ‘ s. De code die ze van het type is opgeslagen in tekstbestanden. Deze bevat de broncode voor dit programma.
Ze gebruiken een versie controle systeem, of VCS (Git is de meest populaire), vastleggen van wijzigingen in de source-code ontwikkeld en verbeterd. Dit betekent dat de programmeur heeft een volledige geschiedenis van alle versies van de source code bestanden. Hij of zij kan je snel toegang krijgen tot alle vorige versie van een bestand. Git slaat bestanden in een archief. Er is een lokaal archief op de computer van iedere ontwikkelaar en een centrale, gedeelde, remote repository die vaak in de cloud gehost.
Wanneer ze klaar zijn om een werkende versie van het programma, zij maken gebruik van een compiler om de broncode te lezen en het genereren van een uitvoerbaar binair bestand.
Door het schrijven van uw documenten in een lichtgewicht, tekst-gebaseerde markup language, kunt u gebruik maken van een VCS-versie de controle van uw schrijven. Wanneer u bent klaar om te verspreiden of publiceren van een document, kunt u gebruik maken van pandoc het genereren van zo veel verschillende versies van de documentatie als je nodig hebt, waaronder web-based (HTML), word-verwerkt of typeset (LibreOffice, Microsoft Word, TeX), PDF (portable document format), e-boek (ePub), enzovoort.
U kunt dit alles doen vanuit een set van versiebeheer, lichtgewicht tekst bestanden.
Het installeren van pandoc
Te installeren pandoc op Ubuntu, gebruik je dit commando:
sudo apt-get install pandoc
Op Fedora, de opdracht die u nodig hebt is het volgende:
sudo dnf installeren pandoc
Op Manjaro, moet je het volgende typen:
sudo pacman -Syu pandoc
U kunt controleren welke versie u hebt geïnstalleerd met de optie –optie versie:
pandoc –versie
Met pandoc Zonder Bestanden
Als u gebruik pandoc zonder commando-regel opties, ook getypte invoer accepteert. Druk je gewoon op Ctrl+D om aan te geven dat u klaar bent met typen. pandoc verwacht van u dat u te typen in de Markdown-formaat, en het genereert HTML-uitvoer.
Laten we eens naar een voorbeeld kijken:
pandoc
We hebben getypt in een paar regels van Markdown en druk op Ctrl+D.
Zodra we dat doen, pandoc genereert het equivalent HTML-uitvoer.
Doen iets nuttigs met pandoc, hoewel we echt nodig om te gebruiken bestanden.
Markdown Basics
Markdown is een lichtgewicht markup language, en de speciale betekenis van bepaalde tekens. U kunt gebruik maken van een platte tekst editor voor het maken van een Markdown-bestand.
Markdown kan ze gemakkelijk gelezen kunnen worden, als er geen visueel omslachtig tags af te leiden uit de tekst. Opmaak in Markdown documenten van de opmaak die het vertegenwoordigt. Hieronder zijn enkele van de basisprincipes:
- Om tekst te benadrukken met cursief, wikkel het in sterretjes. *Dit zal worden benadrukt*
- Voor vette tekst, gebruik je twee sterretjes. **Dit zal worden in vet**
- Koppen worden vertegenwoordigd door het aantal teken/hash teken (#). De tekst is gescheiden van de hash door een spatie. Gebruik een hash voor een top-level heading, twee voor het tweede niveau, enzovoort.
- Voor het maken van een lijst, begin elke regel van de lijst met een sterretje en een spatie in te voegen voor de tekst.
- Om een genummerde lijst, begin elke regel met een cijfer gevolgd door een punt en een spatie in te voegen voor de tekst.
- Om een hyperlink te maken, plaatst u de naam van de site in vierkante haken ([]), en de URL tussen haakjes [()] als volgt: [Link naar Hoe Geek](https://www.howtogeek.com/).
- Een afbeelding invoegen, typ een uitroepteken onmiddellijk vóór de haakjes (![]). Typ een alternatieve tekst voor de afbeelding in de beugels. Vervolgens plaatst u het pad naar de afbeelding tussen haakjes [()”]. Hier is een voorbeeld: .
We dekken meer voorbeelden van al deze in de volgende paragraaf.
GERELATEERD: Wat Is Markdown en Hoe Gebruik Je Het?
Het Converteren Van Bestanden
Bestand conversies zijn eenvoudig. pandoc kan meestal uit te werken welke bestandsformaten u bezig bent met een van hun bestandsnamen. Hier gaan we tot het genereren van een HTML-bestand van een Markdown-bestand. De -o (output) optie vertelt pandoc de naam van het bestand dat we willen maken:
pandoc -o sample.html voorbeeld.md
Ons voorbeeld van de Markdown-bestand, monster.md, bevat het korte deel van Markdown weergegeven in de afbeelding hieronder.
Een bestand met de naam sample.html is gemaakt. Wanneer we dubbelklikken op het bestand, de standaard browser te openen.
Nu, laten we genereren een Open Document Format tekst document kunnen we openen in LibreOffice Writer:
pandoc -o monster.odt monster.md
De ODT-bestand heeft dezelfde inhoud als het HTML-bestand.
Een nette touch is de alternatieve tekst voor de afbeelding wordt ook gebruikt voor het automatisch genereren van een bijschrift voor de afbeelding.
Het Opgeven Van Bestandsformaten
De -f (uit) en -t (te) opties worden gebruikt om te vertellen pandoc die bestanden die je wilt converteren van en naar. Dit kan handig zijn als u werkt met een bestandsindeling die aandelen een bestand met extensie met andere gerelateerde formaten. Bijvoorbeeld, TeX en LaTeX gebruiken “.tex” – extensie.
We zijn ook met behulp van de -s (zelfstandige) optie dus pandoc zal het genereren van alle LaTeX preambule nodig is voor een document om een complete, op zichzelf staande, en goed gevormd LaTeX-document. Zonder de -s (zelfstandige) optie, zou de uitvoer nog steeds goed gevormd LaTeX die kunnen worden vastgezet in een andere LaTeX-document, het zou niet parseren goed als een stand-alone LaTeX-document.
We typt u het volgende:
pandoc -f markdown -t latex -s -o monster.tex monster.md
Als u de “sample.tex-bestand in een tekst-editor, zie je de gegenereerde LaTeX. Als u een LaTeX-editor, kunt u het openen van de TEX-bestand om een preview te zien van hoe de LaTeX typesetting opdrachten worden geïnterpreteerd. Het krimpen van het venster aan te passen op de onderstaande afbeelding gemaakt van de display kijken krap, maar, in werkelijkheid, het was fijn.
We zijn met een LaTeX-editor genoemd Texmaker. Als u wilt om het te installeren in Ubuntu, typt u het volgende:
sudo apt-get install texmaker
In Fedora, de opdracht is:
sudo dnf installeren texmaker
In Manjaro, gebruik:
sudo pacman -Syu texmaker
Het converteren van Bestanden met Sjablonen
U bent waarschijnlijk beginnen te begrijpen van de flexibiliteit die pandoc biedt. U kunt eenmalig schrijven en publiceren in bijna elk formaat. Dat is een geweldige prestatie, maar de documenten zien er een beetje vanille.
Met sjablonen kunt u bepalen welke stijlen pandoc maakt gebruik van wanneer het genereert documenten. U kunt bijvoorbeeld vertellen pandoc gebruik van de stijlen die gedefinieerd zijn in een Cascading Style Sheets (CSS) – bestand met de –css optie.
We hebben een kleine CSS-bestand met de tekst hieronder. Het verandert de ruimte boven en onder het niveau van de koptekst van een stijl. Het verandert ook de kleur van de tekst op wit en de achtergrondkleur op een kleur blauw:
h1 {
color: #FFFFFF;
background-color: #3C33FF;
margin-top: 0px;
margin-bottom: 1px;
}
De volledige opdracht wordt hieronder—merk op dat we ook de stand-alone-optie (-s):
pandoc -o sample.html -s –css monster.css monster.md
pandoc maakt gebruik van de stijl van onze minimalistische CSS-bestand en toegepast op het niveau van een header.
Een andere fine-tuning ” – optie beschikbaar bij het werken met HTML-bestanden is om HTML-code in uw Markdown-bestand. Dit zal worden doorgegeven aan de gegenereerde HTML-bestand als standaard-HTML-markup.
Deze techniek moet worden gereserveerd voor wanneer u alleen het genereren van HTML-uitvoer, hoewel. Als u werkt met meerdere formaten, pandoc negeert de HTML-markup voor niet-HTML-bestanden, en wordt hij doorgegeven naar die tekst.
Wij kunnen aangeven welke stijlen worden gebruikt als ODT-bestanden worden gegenereerd, ook. Open een leeg LibreOffice Writer-document en het aanpassen van de omschrijving en stijlen aan te passen aan uw behoeften. In ons voorbeeld hebben we ook nog een kop-en voettekst. Uw document opslaan als “odt-sjabloon.odt.”
Nu kunnen We dit gebruiken als een sjabloon met de –referentie-doc optie:
pandoc -o monster.odt –referentie-doc=odt-sjabloon.odt monster.md
Vergelijk deze met de ODT voorbeeld van eerder. Dit document maakt gebruik van een ander lettertype, heeft gekleurde koppen, en voorzien van kop-en voetteksten. Echter, het is gegenereerd op basis van exact dezelfde “monster.md” Markdown-bestand.
Referentie document-sjablonen kunnen worden gebruikt voor het aangegeven de verschillende stadia van een document productie. Bijvoorbeeld, misschien hebt u de sjablonen die “Concept” of “Review” watermerken. Een sjabloon zonder een watermerk zou gebruikt worden voor een definitieve document.
Het Genereren Van Pdf ‘ S
Standaard pandoc maakt gebruik van het LaTeX-PDF-engine voor het genereren van PDF-bestanden. De eenvoudigste manier om ervoor te zorgen dat u de juiste LaTeX afhankelijkheden tevreden is de installatie van een LaTeX-editor, zoals Texmaker.
Dat is nogal een grote installeren, al—Tex en LaTeX zijn beide vrij fors. Als uw harde schijf de ruimte beperkt is, of je weet dat je nooit zult gebruiken TeX of LaTeX, kunt u wellicht beter in het genereren van een ODT-bestand. Dan kunt u gewoon openen in LibreOffice Writer en sla het op als een PDF.
Docs-als-Code
Er zijn verschillende voordelen aan het gebruik van Markdown als uw invoertaal wijzigen, waaronder de volgende:
- Werken in de platte tekst bestanden is snel: Ze laden sneller dan vergelijkbare grootte word files, en hebben de neiging om door het document sneller. Veel editors, zoals gedit , Vim , Emacs, het gebruik Markdown syntax highlighting met tekst.
- Je hebt een tijdlijn van alle versies van uw documenten: Als u uw documentatie in een VCS, zoals Git, kun je snel de verschillen zien tussen twee versies van hetzelfde bestand. Echter, dit is alleen echt werkt wanneer de bestanden met onbewerkte tekst, als dat is wat een VCS verwacht om mee te werken.
- Een VCS kunnen registreren wie wijzigingen heeft aangebracht en wanneer: Deze is vooral handig als je vaak samenwerken met anderen aan grote projecten. Het biedt ook een centrale repository voor de documenten zelf. Veel cloud-hosted Git diensten, zoals GitHub, GitLab, en BitBucket, gratis lagen in hun modellen.
- U kunt het genereren van uw documenten in meerdere formaten: Met slechts een paar eenvoudige shell scripts, je kunt trekken in de stijlen van CSS en referentiedocumenten. Als je opslaan van uw documenten in een VCS-repository die integreert met Continuous Integration en Continuous Deployment (CI/CD) platforms, kunnen ze automatisch gegenereerd worden wanneer de software is gebouwd.
GERELATEERD: Wat Is GitHub, en waar Wordt Het Voor Gebruikt?
Laatste Gedachten
Er zijn veel meer opties en functies binnen pandoc is dan wat we hier besproken. De conversie processen voor de meeste bestandstypen kunnen worden bijgestuurd en verfijnd. Voor meer informatie, check out de uitstekende voorbeelden op de officiële (en zeer gedetailleerde) pandoc web pagina.
LEES VERDER
- “Hoe Gebruik pandoc om Bestanden te Converteren op de Linux Command Line
- “Hoe te Werk om een Kapotte Toetsenbord op een Windows PC 10
- “Het Verbergen van de Taakbalk in Windows 10
- “Wat Doet Apple T2 “de Beveiligings-Chip” Doen in Uw Mac?
- “Kan Je Echt “Zoom en Verbeteren” Beveiliging Materiaal?