Cara Menggunakan pandoc untuk Menukar Fail pada Barisan Perintah Linux

Tetingkap terminal berjalan pada komputer riba Linux dengan tema desktop gaya Ubuntu.

Fatmawati Achmad Zaenuri/Shutterstock



Anda boleh menggunakan |__+_| pada Linux untuk menukar antara lebih daripada 40 format fail. Anda juga boleh menggunakannya untuk mencipta sistem docs-as-code yang ringkas dengan menulis dalam Markdown, menyimpan dalam |_+_| dan menerbitkan dalam mana-mana format yang disokongnya.

Penukaran Dokumen dan Docs-as-Cod

Jika anda mempunyai dokumen dalam mana-mana |_+_| banyak format fail yang disokong , menukarnya kepada mana-mana yang lain adalah mudah. Itulah alat yang berguna untuk dimiliki!





Tetapi kuasa sebenar |__+_| menjadi jelas apabila anda menggunakannya sebagai asas sistem docs-as-code yang mudah. Premis docs-as-code adalah untuk menerima pakai beberapa teknik dan prinsip pembangunan perisian dan menggunakannya untuk menulis dokumentasi, terutamanya untuk projek pembangunan perisian. Anda boleh menggunakannya untuk pembangunan apa-apa jenis dokumentasi, walaupun.

Pembangun perisian menggunakan editor kegemaran mereka atau persekitaran pembangunan bersepadu (IDE) untuk menulis program mereka. Kod yang mereka taip disimpan dalam fail teks. Ini mengandungi kod sumber untuk program tersebut.



Mereka menggunakan a sistem kawalan versi , atau VCS ( pergi adalah yang paling popular), untuk menangkap perubahan pada kod sumber semasa ia dibangunkan dan dipertingkatkan. Ini bermakna pengaturcara mempunyai sejarah lengkap semua versi fail kod sumber. Dia boleh mengakses mana-mana versi fail sebelumnya dengan cepat. Git menyimpan fail dalam repositori. Terdapat repositori tempatan pada setiap komputer pembangun dan repositori pusat, dikongsi, jauh yang selalunya dihoskan awan.

Iklan

Apabila mereka bersedia untuk menghasilkan versi program yang berfungsi, mereka menggunakan a penyusun untuk membaca kod sumber dan menjana boleh laku binari.

Dengan menulis dokumen anda dalam bahasa penanda berasaskan teks yang ringan, anda boleh menggunakan VCS untuk mengawal versi tulisan anda. Apabila anda bersedia untuk mengedarkan atau menerbitkan dokumen, anda boleh menggunakan |_+_| untuk menjana seberapa banyak versi dokumentasi anda yang berbeza yang anda perlukan, termasuk berasaskan web ( HTML ), diproses perkataan atau set taip ( LibreOffice , Microsoft word , TeX ), format dokumen mudah alih ( Pdf ), e-book ( ePub ), dan sebagainya.



Anda boleh melakukan semua ini daripada satu set fail teks yang dikawal versi dan ringan.

Memasang pandoc

Untuk memasang |_+_| pada Ubuntu, gunakan arahan ini:

pandoc

Pada Fedora, arahan yang anda perlukan adalah seperti berikut:

git

Di Manjaro, anda perlu menaip:

pandoc's

Anda boleh menyemak versi yang telah anda pasang dengan menggunakan |__+_| pilihan:

pandoc

Menggunakan pandoc Tanpa Fail

Jika anda menggunakan |__+_| tanpa sebarang pilihan baris arahan, ia juga menerima input yang ditaip. Anda hanya tekan Ctrl+D untuk menandakan anda telah selesai menaip. |_+_| mengharapkan anda menaip dalam format Markdown, dan ia menjana output HTML.

Mari lihat contoh:

pandoc

Kami telah menaip beberapa baris Markdown dan akan menekan Ctrl+D.

Iklan

Sebaik sahaja kami melakukannya, |__+_| menghasilkan output HTML yang setara.

Untuk melakukan apa-apa yang berguna dengan |__+_|, walaupun, kita benar-benar perlu menggunakan fail.

Asas Markdown

Markdown ialah bahasa penanda yang ringan, dan makna istimewa diberikan kepada aksara tertentu. Anda boleh menggunakan editor teks biasa untuk membuat fail Markdown.

Penurunan harga boleh dibaca dengan mudah, kerana tiada tag yang menyusahkan secara visual untuk mengalih perhatian daripada teks. Pemformatan dalam dokumen Markdown menyerupai pemformatan yang diwakilinya. Di bawah adalah beberapa asas:

  • Untuk menekankan teks dengan huruf condong , bungkusnya dengan asterisk. |_+_|
  • Kepada berani teks, gunakan dua asterisk. |_+_|
  • Tajuk diwakili oleh tanda nombor/tanda cincang (|_+_|). Teks dipisahkan daripada cincang dengan ruang. Gunakan satu cincang untuk tajuk peringkat atas, dua untuk peringkat kedua dan seterusnya.
  • Untuk membuat senarai bertitik tumpu mata, mulakan setiap baris senarai dengan asterisk dan sisipkan ruang sebelum teks.
  • Untuk membuat senarai bernombor, mulakan setiap baris dengan digit diikuti dengan noktah, dan kemudian masukkan ruang sebelum teks.
  • Untuk membuat hiperpautan, sertakan nama tapak dalam kurungan segi empat sama (|_+_|), dan URL dalam kurungan [|_+_|] seperti: |_+_|.
  • Untuk memasukkan imej, taip tanda seru sejurus sebelum kurungan (|_+_|). Taip sebarang teks alternatif untuk imej dalam kurungan. Kemudian, sertakan laluan ke imej dalam kurungan [|_+_|]. Berikut ialah contoh: |__+_|.

Kami akan merangkumi lebih banyak contoh semua ini dalam bahagian seterusnya.

BERKAITAN: Apakah Markdown dan Bagaimana Anda Menggunakannya?

Menukar Fail

Penukaran fail adalah mudah. |_+_| biasanya boleh menentukan format fail yang anda gunakan daripada nama fail mereka. Di sini, kami akan menjana fail HTML daripada fail Markdown. |_+_| (output) pilihan memberitahu |__+_| nama fail yang ingin kami buat:

pandoc

Iklan

Contoh fail Markdown kami, sample.md, mengandungi bahagian pendek Markdown yang ditunjukkan dalam imej di bawah.

Teks turun harga dalam fail sample.md dalam tetingkap editor gedit.

Fail yang dipanggil sample.html dicipta. Apabila kami mengklik dua kali pada fail tersebut, penyemak imbas lalai kami akan membukanya.

Paparan HTML bagi fail markdown sample.md, dalam tetingkap penyemak imbas.

Sekarang, mari kita hasilkan Buka Format Dokumen dokumen teks yang boleh kami buka Penulis LibreOffice :

--version

Fail ODT mempunyai kandungan yang sama seperti fail HTML.

Dokumen ODT yang diberikan daripada penurunan harga dan dibuka dalam Penulis LibreOffice.

Sentuhan yang kemas ialah teks alternatif untuk imej juga digunakan untuk menjana kapsyen secara automatik untuk angka tersebut.

Kapsyen angka yang dijana secara automatik dalam LibreOffice Writer.

Menentukan Format Fail

|_+_| (dari) dan |__+_| (kepada) pilihan digunakan untuk memberitahu |_+_| format fail yang anda ingin tukar dari dan ke. Ini boleh berguna jika anda menggunakan format fail yang berkongsi sambungan fail dengan format lain yang berkaitan. Sebagai contoh, TeX , dan LaTeX kedua-duanya menggunakan sambungan .tex.

Kami juga menggunakan |__+_| pilihan (berdiri sendiri) jadi |__+_| akan menjana semua mukadimah LaTeX yang diperlukan untuk dokumen menjadi dokumen LaTeX yang lengkap, serba lengkap dan terbentuk dengan baik. Tanpa |_+_| (berdiri sendiri), output masih akan menjadi LaTeX yang terbentuk dengan baik yang boleh dimasukkan ke dalam dokumen LaTeX lain, ia tidak akan menghuraikan dengan betul sebagai dokumen LaTeX kendiri.

Kami menaip yang berikut:

pandoc

Iklan

Jika anda membuka fail sample.tex dalam editor teks, anda akan melihat LaTeX yang dijana. Jika anda mempunyai editor LaTeX, anda boleh membuka fail TEX untuk melihat pratonton tentang cara perintah penetapan taip LaTeX ditafsirkan. Mengecilkan tingkap agar sesuai dengan imej di bawah menjadikan paparan kelihatan sempit, tetapi, pada hakikatnya, ia tidak mengapa.

Fail LaTeX dibuka dalam Texmaker, menunjukkan pratonton halaman set taip.

Kami menggunakan editor LaTeX yang dipanggil Texmaker . Jika anda ingin memasangnya di Ubuntu, taip yang berikut:

pandoc

Di Fedora, arahannya ialah:

pandoc

Di Manjaro, gunakan:

pandoc

Menukar Fail dengan Templat

Anda mungkin mula memahami fleksibiliti yang |__+_| menyediakan. Anda boleh menulis sekali dan menerbitkan dalam hampir semua format. Itu satu pencapaian yang hebat, tetapi dokumen itu kelihatan sedikit vanila.

Dengan templat, anda boleh menentukan gaya |__+_| digunakan apabila ia menjana dokumen. Sebagai contoh, anda boleh memberitahu |__+_| untuk menggunakan gaya yang ditakrifkan dalam a Cascading Style Sheets (CSS) dengan fail |__+_| pilihan.

Kami telah mencipta fail CSS kecil yang mengandungi teks di bawah. Ia menukar jarak di atas dan di bawah gaya pengepala tahap satu. Ia juga menukar warna teks kepada putih, dan warna latar belakang kepada warna biru:

*This will be emphasized*

Perintah penuh adalah di bawah—perhatikan bahawa kami juga menggunakan pilihan kendiri (|_+_|):

**This will be in bold**Iklan

|_+_| menggunakan gaya tunggal daripada fail CSS minimalis kami dan menggunakannya pada pengepala tahap satu.

HTML yang diberikan daripada penurunan harga dengan gaya CSS digunakan pada tajuk tahap satu, dalam tetingkap penyemak imbas

Satu lagi pilihan penalaan halus yang anda ada semasa bekerja dengan fail HTML ialah memasukkan penanda HTML dalam fail Markdown anda. Ini akan dihantar ke fail HTML yang dijana sebagai penanda HTML standard.

Teknik ini harus dikhaskan untuk apabila anda hanya menjana output HTML, walaupun. Jika anda menggunakan berbilang format fail, |__+_| akan mengabaikan penanda HTML untuk fail bukan HTML, dan ia akan dihantar kepada mereka sebagai teks.

Kami boleh menentukan gaya yang digunakan apabila fail ODT dijana juga. Buka dokumen LibreOffice Writer kosong dan laraskan tajuk dan gaya fon untuk memenuhi keperluan anda. Dalam contoh kami, kami juga menambah pengepala dan pengaki. Simpan dokumen anda sebagai odt-template.odt.

Kini kita boleh menggunakan ini sebagai templat dengan |__+_| pilihan:

#

Bandingkan ini dengan contoh ODT dari awal. Dokumen ini menggunakan fon yang berbeza, mempunyai tajuk berwarna dan termasuk pengepala dan pengaki. Walau bagaimanapun, ia dijana daripada fail sample.md Markdown yang sama.

Fail ODT yang diberikan daripada penurunan harga dengan dokumen LibreOffice bertindak sebagai helaian gaya, dalam tetingkap LibreOffice Writer.

Iklan

Templat dokumen rujukan boleh digunakan untuk menunjukkan peringkat yang berbeza dalam pengeluaran dokumen. Contohnya, anda mungkin mempunyai templat yang mempunyai tera air Draf atau Untuk Semakan. Templat tanpa tera air akan digunakan untuk dokumen yang dimuktamadkan.

Menjana PDF

Secara lalai, |_+_| menggunakan enjin PDF LaTeX untuk menjana fail PDF. Cara paling mudah untuk memastikan anda mempunyai kebergantungan LaTeX yang sesuai yang berpuas hati adalah dengan memasang editor LaTeX, seperti Texmaker.

Itu pemasangan yang agak besar, walaupun-Tex dan LaTeX kedua-duanya agak besar. Jika ruang cakera keras anda terhad, atau anda tahu anda tidak akan pernah menggunakan TeX atau LaTeX, anda mungkin lebih suka menjana fail ODT. Kemudian, anda hanya boleh membukanya dalam LibreOffice Writer dan menyimpannya sebagai PDF.

Docs-as-Cod

Terdapat beberapa kelebihan menggunakan Markdown sebagai bahasa penulisan anda, termasuk yang berikut:

    Bekerja dalam fail teks biasa adalah pantas:Mereka memuatkan lebih cepat daripada fail pemproses kata bersaiz sama, dan cenderung untuk bergerak melalui dokumen dengan lebih pantas juga. Banyak editor, termasuk |__+_| , |_+_| , dan |_+_|, gunakan penyerlahan sintaks dengan teks Markdown. Anda akan mempunyai garis masa semua versi dokumen anda:Jika anda menyimpan dokumentasi anda dalam VCS, seperti Git, anda boleh melihat perbezaan antara mana-mana dua versi fail yang sama dengan mudah. Walau bagaimanapun, ini hanya benar-benar berfungsi apabila fail adalah teks biasa, kerana itulah yang diharapkan oleh VCS untuk berfungsi. VCS boleh merekodkan siapa yang membuat sebarang perubahan, dan bila:Ini amat membantu jika anda sering bekerjasama dengan orang lain dalam projek besar. Ia juga menyediakan repositori pusat untuk dokumen itu sendiri. banyak perkhidmatan Git yang dihoskan awan, seperti GitHub , GitLab , dan BitBucket , mempunyai peringkat percuma dalam model harga mereka. Anda boleh menjana dokumen anda dalam pelbagai format:Dengan hanya beberapa skrip shell mudah, anda boleh menarik gaya daripada CSS dan dokumen rujukan. Jika anda menyimpan dokumen anda dalam repositori VCS yang berintegrasi dengan Integrasi Berterusan dan Penerapan Berterusan (CI/CD), ia boleh dijana secara automatik apabila perisian dibina.

BERKAITAN: Apakah GitHub, dan Untuk Apa Ia Digunakan?

Fikiran Akhir

Terdapat banyak lagi pilihan dan ciri di dalamnya pandoc daripada apa yang telah kami bincangkan di sini. Proses penukaran untuk kebanyakan jenis fail boleh diubah suai dan diperhalusi. Untuk mengetahui lebih lanjut, lihat contoh terbaik pada rasmi (dan sangat terperinci) laman web pandoc .

Perintah Linux
Fail tar · pv · kucing · tac · chmod · cengkaman · perbezaan · sed · Dengan · lelaki · pushd · popd · fsck · testdisk · seq · fd · pandoc · CD · $PATH · awk · sertai · jq · lipat · uniq · journalctl · ekor · negeri · ls · fstab · dibuang · kurang · chgrp · chown · rev · tengok · rentetan · taip · menamakan semula · zip · buka zip · lekapkan · umount · pasang · fdisk · mkfs · rm · rmdir · rsync · df · gpg · kita · nano · mkdir · daripada · ln · tampalan · menukar · rclone · carik-carik · SRM
Proses alias · skrin · atas · bagus · renice · kemajuan · jejak · sistem · tmux · chsh · sejarah · di · kumpulan · percuma · yang · dmesg · usermod · ps · chroot · xargs · tty · pinky · lsof · vmstat · masa tamat · dinding · ya · bunuh · tidur · sudo · miliknya · masa · tambah kumpulan · usermod · kumpulan · lshw · menutup · but semula · berhenti · matikan · passwd · lscpu · crontab · Tarikh · bg · fg
Rangkaian netstat · ping · traceroute · ip · ss · siapakah · fail2ban · bmon · awak · jari · nmap · ftp · keriting · wget · who · siapakah saya · Dalam · iptables · ssh-keygen · ufw

BERKAITAN: Komputer Riba Linux Terbaik untuk Pembangun dan Penggemar

BACA SETERUSNYA Foto Profil untuk Dave McKay Dave McKay
Dave McKay pertama kali menggunakan komputer apabila pita kertas yang ditebuk sedang popular, dan dia telah memprogramkan sejak itu. Selepas lebih 30 tahun dalam industri IT, beliau kini seorang wartawan teknologi sepenuh masa. Semasa kerjayanya, beliau telah bekerja sebagai pengaturcara bebas, pengurus pasukan pembangunan perisian antarabangsa, pengurus projek perkhidmatan IT, dan, yang terbaru, sebagai Pegawai Perlindungan Data. Tulisannya telah diterbitkan oleh howtogeek.com, cloudsavvyit.com, itenterpriser.com, dan opensource.com. Dave ialah seorang penginjil Linux dan penyokong sumber terbuka.
Baca Bio Penuh

Artikel Yang Menarik