Kako koristiti pandoc za pretvaranje datoteka u naredbenom retku Linuxa

Prozor terminala koji radi na prijenosnom računalu s Linuxom s temom radne površine u Ubuntu stilu.

Fatmawati Achmad Zaenuri/Shutterstock



Možete koristiti |_+_| na Linuxu za pretvaranje između više od 40 formata datoteka. Također ga možete koristiti za stvaranje jednostavnog sustava dokumenti kao kod pisanjem u Markdownu, pohranjivanjem u |_+_| i objavljivanjem u bilo kojem od podržanih formata.

Pretvorba dokumenta i dokumenti kao kod

Ako imate dokument u bilo kojem od |_+_| mnogi podržani formati datoteka , pretvoriti ga u bilo koji drugi je cinch. To je zgodan alat!





Ali stvarna moć |_+_| postaje očito kada ga koristite kao osnovu jednostavnog sustava dokumenti kao kod. Pretpostavka docs-as-code je usvojiti neke od tehnika i principa razvoja softvera i primijeniti ih na pisanje dokumentacije, posebno za projekte razvoja softvera. Ipak, možete ga primijeniti na razvoj bilo koje vrste dokumentacije.

Programeri softvera koriste svoj omiljeni uređivač ili integrirano razvojno okruženje (IDE) za pisanje svojih programa. Kôd koji upisuju sprema se u tekstualne datoteke. One sadrže izvorni kod za program.



Oni koriste a sustav kontrole verzija , ili VCS ( ići je najpopularniji), za bilježenje promjena izvornog koda kako se razvija i poboljšava. To znači da programer ima potpunu povijest svih verzija datoteka izvornog koda. On ili ona mogu brzo pristupiti bilo kojoj prethodnoj verziji datoteke. Git pohranjuje datoteke u spremište. Postoji lokalno spremište na računalu svakog programera i središnje, zajedničko, udaljeno spremište koje se često nalazi u oblaku.

Oglas

Kada su spremni za proizvodnju radne verzije programa, koriste a prevodilac za čitanje izvornog koda i generiranje binarne izvršne datoteke.

Pisanjem dokumenata u laganom, tekstualnom jeziku za označavanje, možete koristiti VCS za kontrolu verzije. Kada ste spremni za distribuciju ili objavljivanje dokumenta, možete koristiti |_+_| da generirate onoliko različitih verzija vaše dokumentacije koliko vam je potrebno, uključujući web-bazirane ( HTML ), tekstualno obrađeno ili napisano ( LibreOffice , Microsoft Word , TeX ), prijenosni format dokumenta ( PDF ), e-knjiga ( ePub ), i tako dalje.



Sve to možete učiniti iz jednog skupa laganih tekstualnih datoteka kontroliranih verzijama.

Instaliranje pandoc-a

Za instaliranje |_+_| na Ubuntu, koristite ovu naredbu:

pandoc

Na Fedori, naredba koja vam je potrebna je sljedeća:

git

Na Manjaru trebate upisati:

pandoc's

Možete provjeriti koju verziju ste instalirali pomoću |_+_| opcija:

pandoc

Korištenje pandoc-a bez datoteka

Ako koristite |_+_| bez ikakvih opcija naredbenog retka, također prihvaća tipkani unos. Samo pritisnite Ctrl+D da biste označili da ste završili s tipkanjem. |_+_| očekuje da upišete u Markdown formatu i generira HTML izlaz.

Pogledajmo primjer:

pandoc

Upisali smo nekoliko redaka Markdowna i upravo ćemo pritisnuti Ctrl+D.

Oglas

Čim to učinimo, |_+_| generira ekvivalentan HTML izlaz.

Međutim, da bismo učinili bilo što korisno s |_+_|, stvarno moramo koristiti datoteke.

Markdown Osnove

Smanjenje je lagani označni jezik, a određenim znakovima se daje posebno značenje. Možete koristiti uređivač običnog teksta za izradu Markdown datoteke.

Markdown se može lako pročitati jer nema vizualno glomaznih oznaka koje bi odvratile pažnju od teksta. Formatiranje u Markdown dokumentima nalikuje oblikovanju koje predstavlja. Ispod su neke od osnova:

  • Za isticanje teksta s kurziv , umotajte ga u zvjezdice. |_+_|
  • Do podebljano teksta, koristite dvije zvjezdice. |_+_|
  • Naslovi su predstavljeni znakom broja/hash oznakom (|_+_|). Tekst je odvojen od hasha razmakom. Koristite jedan hash za naslov najviše razine, dva za drugu razinu i tako dalje.
  • Da biste stvorili popis s grafičkim oznakama, započnite svaki redak popisa zvjezdicom i umetnite razmak ispred teksta.
  • Da biste stvorili numerirani popis, započnite svaki redak znamenkom nakon koje slijedi točka, a zatim umetnite razmak ispred teksta.
  • Da biste stvorili hipervezu, stavite naziv stranice u uglaste zagrade (|_+_|), a URL u zagrade [|_+_|] ovako: |_+_|.
  • Da biste umetnuli sliku, upišite uskličnik neposredno ispred zagrada (|_+_|). Upišite bilo koji alternativni tekst za sliku u zagrade. Zatim stavite put do slike u zagrade [|_+_|]. Evo primjera: |_+_|.

U sljedećem ćemo odjeljku pokriti više primjera svega ovoga.

POVEZANO: Što je Markdown i kako ga koristite?

Pretvaranje datoteka

Pretvorbe datoteka su jednostavne. |_+_| obično može odrediti s kojim formatima datoteka radite iz njihovih naziva datoteka. Ovdje ćemo generirati HTML datoteku iz Markdown datoteke. The |_+_| (izlaz) opcija govori |_+_| naziv datoteke koju želimo stvoriti:

pandoc

Oglas

Naš uzorak Markdown datoteke, sample.md, sadrži kratki dio Markdowna prikazan na donjoj slici.

Markdown tekst u datoteci sample.md u prozoru uređivača gedit.

Stvara se datoteka pod nazivom sample.html. Kada dvaput kliknemo datoteku, otvorit će je naš zadani preglednik.

HTML prikaz datoteke sample.md markdown, u prozoru preglednika.

Sada, generirajmo an Otvorite format dokumenta tekstualni dokument u kojem možemo otvoriti LibreOffice Writer :

--version

ODT datoteka ima isti sadržaj kao i HTML datoteka.

ODT dokument renderiran iz markdowna i otvoren u LibreOffice Writeru.

Uredan dodir je alternativni tekst za sliku koji se također koristi za automatsko generiranje natpisa za sliku.

Automatski generirani natpis figure u LibreOffice Writeru.

Određivanje formata datoteka

The |_+_| (od) i |_+_| (to) opcije se koriste da kažu |_+_| u koje formate datoteka želite pretvoriti. To može biti korisno ako radite s formatom datoteke koji dijeli ekstenziju datoteke s drugim srodnim formatima. Na primjer, TeX , i Lateks oba koriste ekstenziju .tex.

Također koristimo |_+_| (samostalna) opcija pa |_+_| će generirati svu LaTeX preambulu potrebnu da dokument bude potpun, samostalan i dobro oblikovan LaTeX dokument. Bez |_+_| (samostalna) opcija, izlaz bi i dalje bio dobro oblikovan LaTeX koji bi se mogao smjestiti u drugi LaTeX dokument, ne bi se pravilno analizirao kao samostalni LaTeX dokument.

Upisujemo sljedeće:

pandoc

Oglas

Ako otvorite datoteku sample.tex u uređivaču teksta, vidjet ćete generirani LaTeX. Ako imate LaTeX uređivač, možete otvoriti TEX datoteku da vidite pregled načina na koji se tumače naredbe LaTeX-a. Smanjivanjem prozora kako bi stao na sliku ispod, zaslon je izgledao skučeno, ali u stvarnosti je bilo u redu.

LaTeX datoteka otvorena u Texmakeru, koja prikazuje pregled stranice s postavom teksta.

Koristili smo LaTeX editor tzv Texmaker . Ako ga želite instalirati u Ubuntu, upišite sljedeće:

pandoc

U Fedori, naredba je:

pandoc

U Manjarou koristite:

pandoc

Pretvaranje datoteka s predlošcima

Vjerojatno počinjete shvaćati fleksibilnost koja |_+_| pruža. Možete pisati jednom i objaviti u gotovo bilo kojem formatu. To je sjajan podvig, ali dokumenti izgledaju pomalo vani.

S predlošcima možete diktirati koji stilovi |_+_| koristi kada generira dokumente. Na primjer, možete reći |_+_| koristiti stilove definirane u a Kaskadni listovi stilova (CSS) datoteku s |_+_| opcija.

Napravili smo malu CSS datoteku koja sadrži tekst u nastavku. Mijenja razmak iznad i ispod zaglavlja razine jedan stil. Također mijenja boju teksta u bijelu, a boju pozadine u nijansu plave:

*This will be emphasized*

Cijela naredba je u nastavku - imajte na umu da smo također koristili samostalnu opciju (|_+_|):

**This will be in bold**Oglas

|_+_| koristi jedan stil iz naše minimalističke CSS datoteke i primjenjuje ga na zaglavlje prve razine.

HTML prikazan iz markdowna sa CSS stilom primijenjenim na naslov prve razine, u prozoru preglednika

Još jedna opcija finog podešavanja koja vam je dostupna kada radite s HTML datotekama je uključivanje HTML oznake u vašu Markdown datoteku. Ovo će biti proslijeđeno u generiranu HTML datoteku kao standardna HTML oznaka.

Međutim, ova tehnika bi trebala biti rezervirana za kada generirate samo HTML izlaz. Ako radite s više formata datoteka, |_+_| zanemarit će HTML oznake za datoteke koje nisu HTML i bit će proslijeđene onima kao tekst.

Možemo odrediti koji se stilovi također koriste kada se generiraju ODT datoteke. Otvorite prazan dokument LibreOffice Writer i prilagodite naslove i stilove fonta svojim potrebama. U našem primjeru dodali smo i zaglavlje i podnožje. Spremite dokument kao odt-template.odt.

Sada ovo možemo koristiti kao predložak s |_+_| opcija:

#

Usporedite ovo s prethodnim primjerom ODT-a. Ovaj dokument koristi drugačiji font, ima naslove u boji i uključuje zaglavlja i podnožja. Međutim, generiran je iz iste datoteke sample.md Markdown.

ODT datoteka generirana iz markdowna s LibreOffice dokumentom koji djeluje kao stilski list, u prozoru LibreOffice Writer.

Oglas

Predlošci referentnih dokumenata mogu se koristiti za označavanje različitih faza izrade dokumenta. Na primjer, možda imate predloške koji imaju vodene žigove Nacrt ili Za pregled. Za dovršeni dokument koristit će se predložak bez vodenog žiga.

Generiranje PDF-ova

Prema zadanim postavkama, |_+_| koristi LaTeX PDF motor za generiranje PDF datoteka. Najlakši način da se uvjerite da ste zadovoljili odgovarajuće LaTeX ovisnosti je instalirati LaTeX uređivač, kao što je Texmaker.

Međutim, to je prilično velika instalacija - i Tex i LaTeX su prilično pozamašni. Ako vam je prostor na tvrdom disku ograničen ili znate da nikada nećete koristiti TeX ili LaTeX, možda biste radije generirali ODT datoteku. Zatim ga možete jednostavno otvoriti u LibreOffice Writer-u i spremiti ga kao PDF.

Dokumenti kao kod

Postoji nekoliko prednosti korištenja Markdowna kao jezika pisanja, uključujući sljedeće:

    Rad u tekstualnim datotekama je brz:Učitavaju se brže od datoteka procesora teksta slične veličine, a također se brže kreću kroz dokument. Mnogi urednici, uključujući |_+_| , |_+_| , i |_+_|, koriste isticanje sintakse s tekstom Markdown. Imat ćete vremenski okvir svih verzija vaših dokumenata:Ako svoju dokumentaciju pohranite u VCS, kao što je Git, lako možete vidjeti razlike između bilo koje dvije verzije iste datoteke. Međutim, ovo stvarno funkcionira samo kada su datoteke običan tekst, jer to VCS očekuje da će raditi. VCS može zabilježiti tko je napravio promjene i kada:Ovo je osobito korisno ako često surađujete s drugima na velikim projektima. Također pruža središnje spremište za same dokumente. Puno Git usluge koje se nalaze u oblaku, kao što je GitHub , GitLab , i BitBucket , imaju besplatne razine u svojim modelima cijena. Svoje dokumente možete generirati u više formata:Uz samo nekoliko jednostavnih shell skripti, možete izvući stilove iz CSS-a i referentnih dokumenata. Ako svoje dokumente pohranjujete u VCS spremište koje se integrira s Kontinuirana integracija i kontinuirana implementacija (CI/CD) platforme, mogu se automatski generirati kad god se softver izgradi.

POVEZANO: Što je GitHub i za što se koristi?

Završne misli

Postoji mnogo više opcija i značajki unutar pandok od onoga što smo ovdje pokrili. Procesi pretvorbe za većinu vrsta datoteka mogu se podesiti i fino podesiti. Da biste saznali više, pogledajte izvrsne primjere na službenoj (i iznimno detaljne) pandoc web stranica .

Linux naredbe
Datoteke katran · pv · mačka · tac · chmod · zahvat · razl · sed · S · čovjek · pushd · popd · fsck · testdisk · sljed · F D · pandok · CD · $PATH · awk · pridružiti · jq · preklopiti · jedinstven · journalctl · rep · država · ls · fstab · izbaciti · manje · chgrp · chown · rev · izgled · žice · tip · preimenovati · patentni zatvarač · otvoriti rajsfešlus · montirati · razmontirati · instalirati · fdisk · mkfs · rm · rmdir · rsync · df · gpg · mi · nano · mkdir · iz · ln · zakrpa · Pretvoriti · rclone · usitniti · SRM
Procesi alias · zaslon · vrh · Lijepo · renice · napredak · strace · sustav · tmux · chsh · povijesti · na · serija · besplatno · koji · dmesg · usermod · p.s · chroot · xargs · tty · ružičasti · lsof · vmstat · pauza · zid · Da · ubiti · spavati · sudo · njegov · vrijeme · groupadd · usermod · grupe · lshw · ugasiti · ponovno podizanje sustava · Stop · isključenje · passwd · lscpu · crontab · datum · bg · fg
Umrežavanje netstat · ping · traceroute · ip · ss · tko je · fail2ban · bmon · vas · prst · nmap · ftp · kovrča · wget · tko · tko sam ja · U · iptables · ssh-keygen · ufw

POVEZANO: Najbolja prijenosna računala s Linuxom za programere i entuzijaste

PROČITAJTE SLJEDEĆE Fotografija profila Davea McKaya Dave McKay
Dave McKay je prvi put koristio računala kada je bušena papirna traka bila u modi i od tada se bavi programiranjem. Nakon više od 30 godina u IT industriji, sada je stalni tehnološki novinar. Tijekom svoje karijere radio je kao freelance programer, voditelj međunarodnog tima za razvoj softvera, voditelj projekta IT usluga, a nedavno i kao službenik za zaštitu podataka. Njegovo pisanje objavili su howtogeek.com, cloudsavvyit.com, tenterpriser.com i opensource.com. Dave je Linux evanđelist i zagovornik otvorenog koda.
Pročitajte cijelu biografiju

Zanimljivi Članci