Formiko, strukturēts teksta redaktors Python dokumentācijai

Par formiko

Nākamajā rakstā mēs ieskatīsimies Formiko. Šis ir neliels redaktors, kas izveidots kopā ar Python un kuru nejauši atradu vietnē GitHub. Formiko ir pieteikumu reStructuredText ar MarkDown redaktoru un priekšskatījumu pārbaudīt paveiktā darba gaitu.

ReStructuredText ir daļa no Docutils projekta un to izmanto Python programmētāji, lai izveidotu tehnisko dokumentāciju. Esmu pārliecināts, ka būs daudz cilvēku, kuri nekad nav dzirdējuši par reStructuredText, taču, izmantojot šo programmu un dažus pamatjēdzienus, jūs redzēsiet, ka šo sintakses sistēmu ir viegli izmantot. Programma ir rakstīta Python ar Gtk3, GtkSourceView un Webkit2. Izmantojiet Docutils un atkārtoti atzīmēt Common Mark Parser.

Jāsaka tā Markdown un reStructuredText ir līdzīgas iespējas. Atšķirībā jāatzīmē, ka reStructuredText ir paredzēts, lai izveidotu dokumentāciju, atbalsta tabulas, zemsvītras piezīmes un gala piezīmes.

ReStructuredText ir viegli lasāma parsētāja un sintakses sistēma. Tas ir noderīgi tiešsaistes programmas dokumentācijai, Python dokumentu virknēm, ātrai vienkāršu tīmekļa lapu izveidošanai un atsevišķiem dokumentiem. ReStructuredText parsētājs ir Docutils sastāvdaļa un ir strukturēto tekstu un Setext vieglo iezīmēšanas sistēmu pārskatīšana un atkārtota interpretācija.

Formiko vispārīgās īpašības

foriko gtk

Formiko

Saskaņā ar projekta GitHub lapu, Formiko ietver šādas funkcijas:

  • Es izveidoju redaktoru, kura pamatā ir GtkSourceView ar sintakses izcelšana un Vim redaktors.
  • Mēs ejam sadaliet darba zonu vertikāli vai horizontāli.
  • Piedāvājumi a priekšskatījuma režīms lai redzētu, kā notiek darbs.
  • JSON un priekšskatījums HTML.
  • Pareizrakstības pārbaude.

Tas ir saderīgs arī ar:

Formiko instalēšana Ubuntu

Par šo rakstu es to darīšu instalējiet Formiko Ubuntu 18.04. Mēs atradīsim šo programmu pieejamu Debian un BSD, kā mēs to redzam GitHub lapa.

Formiko Vim projekts

Formiko vim

Prasības

Pirms turpināt instalēšanu, jāsaka, ka saskaņā ar viņu GitHub lapu mums tas būs jādara salabo dažus Prasības kas lūdz programmu darboties pareizi, kad mēs to instalējam ar pip3.

  • pitons 2.7 vai 3
  • GTK+3
  • objektu-introspekcija
  • PyGObject
  • Web komplekts
  • GtkSourceView

Mēs atveram termināli (Ctrl + Alt + T) un rakstām:

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

Es vēlreiz vēlos precizēt, ka es veicu šo instalēšanu Ubuntu 18.04. Kad prasības būs izpildītas, mēs to redzēsim programmas instalēšana tiks veikta caur pip vai apt kā mēs esam ieinteresēti. Priekš izmantot pip3 instalācijā mēs rakstīsim terminālā (Ctrl + Alt + T):

pip3 install formiko

Gadījumā, ja vēlaties izmantot apt, tajā pašā terminālā mēs rakstām:

apt formiko instalācija

sudo apt update && sudo apt install formiko

Jāsaka, ka abas instalācijas nodrošinās mums vienādu programmas versiju. Pēc izvēles mēs varam arī instalēt:

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

Kad mēs to instalēsim, lietojumprogrammas izvēlnē tiks pievienoti divi ieraksti: Formiko y Formiko vim.

Formiko palaidējs un Formiko Vim

Mums būs jāatrod tas, kas vislabāk atbilst mūsu vajadzībām.

Atinstalējiet Formiko

Tā kā mēs esam redzējuši divas instalēšanas iespējas, mēs redzēsim arī divas komandas, lai noņemtu programmu no mūsu operētājsistēmas.

Pirmā no komandām būs tā, kas atsaucas uz uzstādīšana veikta ar pip3. Lai izslēgtu programmu, mēs atvērsim termināli (Ctrl + Alt + T) un ierakstīsim tajā:

sudo pip3 uninstall formiko

Tagad mēs redzēsim komandu tiem, kas izvēlējās instalācija ar apt. Terminālā (Ctrl + Alt + T) mēs rakstām:

sudo apt purge formiko && sudo apt autoremove

Iespējams, ka tā nav vislabākā no funkcijām, taču man jāsaka, ka Formiko strādāja bez problēmām, kamēr es to pārbaudīju. Es negribu beigt, vispirms nerunājot par to, kas, iespējams, ir šīs programmas lielākais melnais punkts formāta ierobežojums ar kuru ļauj mums strādāt

Plašāku informāciju par šo programmu var iegūt Projekts GitHub.


Atstājiet savu komentāru

Jūsu e-pasta adrese netiks publicēta. Obligātie lauki ir atzīmēti ar *

*

*

  1. Atbildīgais par datiem: Migels Ángels Gatóns
  2. Datu mērķis: SPAM kontrole, komentāru pārvaldība.
  3. Legitimācija: jūsu piekrišana
  4. Datu paziņošana: Dati netiks paziņoti trešām personām, izņemot juridiskus pienākumus.
  5. Datu glabāšana: datu bāze, ko mitina Occentus Networks (ES)
  6. Tiesības: jebkurā laikā varat ierobežot, atjaunot un dzēst savu informāciju.