„Formiko“, struktūrinis „Python“ dokumentacijos teksto redaktorius

Apie formiko

Kitame straipsnyje apžvelgsime „Formiko“. Tai nedidelis redaktorius, sukurtas kartu su „Python“, kurį atsitiktinai radau „GitHub“. Formiko yra paraiška restruktūrizuotas tekstas su „MarkDown“ redaktoriumi ir peržiūra patikrinti atlikto darbo eigą.

ReStructuredText yra projekto „Docutils“ dalis ir „Python“ programuotojai naudoja techninei dokumentacijai kurti. Esu įsitikinęs, kad bus daug žmonių, kurie niekada nebuvo girdėję apie „reStructuredText“, tačiau naudodamiesi šia programa ir kai kuriomis pagrindinėmis sąvokomis pamatysite, kad šia sintaksės sistema naudotis lengva. Programa parašyta „Python“ su „Gtk3“, „GtkSourceView“ ir „Webkit2“. Naudokite Docutils ir pakartotinai pažymėti „Common Mark Parser“.

Reikia pasakyti taip Akcijos kainos ir reStructuredText turi panašias galimybes. Kaip skirtumą, reikia pažymėti, kad „reStructuredText“ yra skirtas kurti dokumentaciją, jis palaiko lenteles, išnašas ir išnašas.

„ReStructuredText“ yra lengvai skaitoma analizatoriaus ir sintaksės sistema. Tai naudinga internetinei programos dokumentacijai, „Python“ dokumentų eilutėms, norint greitai sukurti paprastus tinklalapius ir atskiriems dokumentams. „ReStructuredText“ analizatorius yra „Docutils“ komponentas ir yra „StructuredText“ ir „Setext“ lengvųjų žymėjimo sistemų peržiūra ir aiškinimas.

Bendrosios „Formiko“ savybės

foriko gtk

Formiko

Pagal projekto „GitHub“ puslapį „Formiko“ apima šias funkcijas:

  • Aš sukūriau redaktorių pagal „GtkSourceView“ su sintaksės paryškinimas ir „Vim“ redaktorius.
  • Mes einame padalinti darbo zoną vertikaliai arba horizontaliai.
  • Siūlo a peržiūros režimas norėdami pamatyti, kaip vyksta darbas.
  • JSON ir peržiūra HTML.
  • Rašybos tikrinimas.

Jis taip pat suderinamas su:

„Formiko“ diegimas „Ubuntu“

Už šį straipsnį aš įdiekite „Formiko“ į „Ubuntu“ 18.04. Šią programą rasime Debianui ir BSD, kaip matome joje „GitHub“ puslapis.

„Formiko Vim“ projektas

Formiko vim

Reikalavimai

Prieš tęsdami diegimą, reikia pasakyti, kad pagal jų „GitHub“ puslapį mes turėsime tai padaryti pataisyti kai kuriuos reikalavimai kuris prašo programos tinkamai veikti, kai mes ją įdiegiame su pip3.

  • pitonas 2.7 arba 3
  • GTK+3
  • objektas-savistaba
  • „PyGObject“
  • „Webkit“
  • „GtkSourceView“

Atidarome terminalą („Ctrl“ + „Alt“ + T) ir rašome:

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

Dar kartą noriu patikslinti, kad atlieku šį diegimą „Ubuntu 18.04“. Kai reikalavimai bus įvykdyti, tai pamatysime programos diegimas bus atliekamas naudojant „pip“ arba „apt“ kaip mus domina. Dėl naudokite pip3 diegime mes parašysime terminale („Ctrl“ + „Alt“ + T):

pip3 install formiko

Tuo atveju, jei norite naudoti apt, tame pačiame terminale mes rašome:

taikliai formiko instaliacija

sudo apt update && sudo apt install formiko

Reikia pasakyti, kad abi instaliacijos mums suteiks tą pačią programos versiją. Pasirinktinai mes taip pat galime įdiegti:

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

Kai mes jį įdiegsime, į programos meniu bus pridėti du įrašai: Formiko y Formiko vim.

„Formiko“ paleidimo priemonė ir „Formiko Vim“

Turėsime rasti tą, kuris geriausiai atitiks mūsų poreikius.

Pašalinkite „Formiko“

Kadangi matėme dvi diegimo parinktis, taip pat pamatysime dvi komandas, kaip pašalinti programą iš mūsų operacinės sistemos.

Pirmoji iš komandų bus ta, kuri nurodo montavimas atliktas su pip3. Norėdami pašalinti programą, atidarysime terminalą („Ctrl“ + „Alt“ + T) ir jame parašysime:

sudo pip3 uninstall formiko

Dabar pamatysime komandą tiems, kurie pasirinko diegimas su apt. Terminale (Ctrl + Alt + T) rašome:

sudo apt purge formiko && sudo apt autoremove

Tai gali būti ne pati geriausia iš savo funkcijų programų, tačiau turiu pasakyti, kad „Formiko“ dirbo be problemų, kol aš ją išbandžiau. Nenoriu baigti, prieš tai nekalbėdamas apie tai, kas yra bene didžiausias šios programos juodasis taškas formato apribojimas su kuriomis leidžia dirbti

Daugiau informacijos apie šią programą galite rasti Projektas „GitHub“.


Palikite komentarą

Jūsų elektroninio pašto adresas nebus skelbiamas. Privalomi laukai yra pažymėti *

*

*

  1. Atsakingas už duomenis: Miguel Ángel Gatón
  2. Duomenų paskirtis: kontroliuoti šlamštą, komentarų valdymą.
  3. Įteisinimas: jūsų sutikimas
  4. Duomenų perdavimas: Duomenys nebus perduoti trečiosioms šalims, išskyrus teisinius įsipareigojimus.
  5. Duomenų saugojimas: „Occentus Networks“ (ES) talpinama duomenų bazė
  6. Teisės: bet kuriuo metu galite apriboti, atkurti ir ištrinti savo informaciją.