Formiko, editor teks terstruktur untuk dokumentasi Python

Tentang formiko

Pada artikel selanjutnya kita akan melihat Formiko. Ini adalah editor kecil yang dibuat dengan Python yang saya temukan secara kebetulan di GitHub. Formiko adalah aplikasi reStructuredText dengan editor dan pratinjau Markdown untuk memeriksa kemajuan pekerjaan yang telah diselesaikan.

ReStructuredText adalah bagian dari proyek Docutils dan digunakan oleh programmer Python untuk membuat dokumentasi teknis. Saya yakin akan banyak orang yang belum pernah mendengar tentang reStructuredText, namun melalui program ini dan beberapa konsep dasar Anda akan melihat bahwa menggunakan sistem sintaksis ini mudah dilakukan. Program ini ditulis dengan Python dengan Gtk3, GtkSourceView, dan Webkit2. Gunakan Docutils dan tandai ulang Common Mark Parser.

Harus dikatakan seperti itu Penurunan harga dan reStructuredText memiliki kemampuan serupa. Sebagai perbedaan, perlu dicatat bahwa reStructuredText dirancang untuk membuat dokumentasi, mendukung tabel dan catatan kaki serta catatan akhir.

ReStructuredText adalah sistem parser dan sintaks yang mudah dibaca. Ini berguna untuk dokumentasi program online, string dokumen Python, untuk membuat halaman web sederhana dengan cepat, dan untuk dokumen yang berdiri sendiri. Pengurai reStructuredText adalah komponen Docutils dan merupakan revisi dan interpretasi ulang dari sistem markup ringan StructuredText dan Setext.

Karakteristik umum Formiko

foriko gtk

formiko

Menurut halaman GitHub proyek, Formiko menyertakan fitur-fitur berikut:

  • Saya berpose dengan editor berdasarkan GtkSourceView penyorotan sintaks dan editor Vim.
  • Kita pergi bagi area kerja secara vertikal atau horizontal.
  • Menawarkan a mode pratinjau untuk melihat bagaimana pekerjaannya.
  • JSON dan pratinjau HTML.
  • Cek ejaan.

Ini juga kompatibel dengan:

Menginstal Formiko di Ubuntu

Untuk artikel ini saya akan instal Formiko di Ubuntu 18.04. Kami akan menemukan program ini tersedia untuk Debian dan BSD seperti yang bisa kita lihat di dalamnya Halaman GitHub.

Proyek Formiko Vim

Formiko vim

Requisitos

Sebelum melanjutkan dengan instalasi, harus dikatakan bahwa menurut halaman GitHub mereka, kita harus melakukannya perbaiki beberapa persyaratan yang meminta program berfungsi dengan benar saat kita menginstalnya dengan pip3.

  • python 2.7 atau 3
  • GTK+3
  • introspeksi-gobject
  • Objek PyGO
  • perangkat web
  • Tampilan Sumber Gtk

Kami membuka terminal (Ctrl + Alt + T) dan menulis:

sudo apt install python3-pip python3-gi python3-docutils gir1.2-gtksource-3.0 \
gir1.2-webkit2-4.0 gir1.2-gtkspell3-3.0

Saya ingin mengklarifikasi lagi bahwa saya melakukan instalasi ini di Ubuntu 18.04. Begitu persyaratannya terpenuhi, kita akan lihat itu penginstalan program akan dilakukan melalui pip atau apt karena kami tertarik. Untuk gunakan pip3 dalam instalasi kita akan menulis di terminal (Ctrl + Alt + T):

pip3 install formiko

Jika Anda lebih suka gunakan apt, di terminal yang sama kami menulis:

instalasi apt formiko

sudo apt update && sudo apt install formiko

Harus dikatakan bahwa kedua penginstalan akan memberi kami versi program yang sama. Secara opsional kami juga dapat menginstal:

sudo apt install vim-gtk3
pip3 install docutils-tinyhtmlwriter recommonmark docutils-html5-writer

Saat kami menginstalnya, dua entri akan ditambahkan ke menu aplikasi: formiko y Formiko vim.

Peluncur Formiko dan Formiko Vim

Kita harus menemukan yang paling sesuai dengan kebutuhan kita.

Copot pemasangan Formiko

Seperti yang telah kita lihat dua opsi instalasi, kita juga akan melihat dua perintah untuk menghapus program dari sistem operasi kita.

Perintah pertama akan menjadi yang merujuk ke instalasi dilakukan dengan pip3. Untuk menghilangkan program kita akan membuka terminal (Ctrl + Alt + T) dan menulis di dalamnya:

sudo pip3 uninstall formiko

Sekarang kita akan melihat perintah untuk mereka yang memilih file instalasi dengan apt. Di terminal (Ctrl + Alt + T) kami menulis:

sudo apt purge formiko && sudo apt autoremove

Ini mungkin bukan program terbaik untuk fungsinya, tetapi saya harus mengatakan bahwa Formiko bekerja tanpa masalah saat saya mengujinya. Saya tidak ingin mengakhiri tanpa terlebih dahulu berbicara tentang apa yang mungkin menjadi titik hitam terbesar dari program ini, yaitu batasan format yang memungkinkan kita untuk bekerja

Informasi lebih lanjut tentang program ini dapat diperoleh di halaman Proyek GitHub.


tinggalkan Komentar Anda

Alamat email Anda tidak akan dipublikasikan. Bidang yang harus diisi ditandai dengan *

*

*

  1. Penanggung jawab data: Miguel Ángel Gatón
  2. Tujuan data: Mengontrol SPAM, manajemen komentar.
  3. Legitimasi: Persetujuan Anda
  4. Komunikasi data: Data tidak akan dikomunikasikan kepada pihak ketiga kecuali dengan kewajiban hukum.
  5. Penyimpanan data: Basis data dihosting oleh Occentus Networks (UE)
  6. Hak: Anda dapat membatasi, memulihkan, dan menghapus informasi Anda kapan saja.