Formiko, en struktureret teksteditor til Python-dokumentation

Om formiko

I den næste artikel skal vi se på Formiko. Dette er en lille editor bygget med Python, som jeg tilfældigvis stødte på på GitHub. Formiko er en ansøgning reStructuredText med en MarkDown-editor og forhåndsvisning for at kontrollere forløbet af det udførte arbejde.

ReStructuredText er en del af Docutils-projektet og bruges af Python-programmører til at oprette teknisk dokumentation. Jeg er sikker på, at der vil være mange mennesker, der aldrig har hørt om reStructuredText, men gennem dette program og nogle grundlæggende begreber vil du se, at det er let at bruge dette syntaks-system. Programmet er skrevet i Python med Gtk3, GtkSourceView og Webkit2. Brug Docutils og almindeligt mærke Parser.

Det skal siges markdown og reStructuredText har lignende muligheder. Som en forskel skal det bemærkes, at reStructuredText er designet til at oprette dokumentation, understøtter tabeller og fodnoter og slutnoter.

ReStructuredText er et letlæseligt parser- og syntaks-system. Det er nyttigt til online programdokumentation, Python-dokumentstrenge, til hurtigt at oprette enkle websider og til enkeltstående dokumenter. ReStructuredText-parseren er en komponent i Docutils og er en revision og genfortolkning af StructuredText og Setext letvægts-markeringssystemer.

Generelle egenskaber ved Formiko

foriko gtk

Formiko

Ifølge projektets GitHub-side inkluderer Formiko følgende funktioner:

  • Jeg stillede en redaktør baseret på GtkSourceView med syntaksfremhævning og en Vim-editor.
  • Vi går del arbejdsområdet lodret eller vandret.
  • Tilbyder en preview-tilstand for at se hvordan arbejdet er.
  • JSON og forhåndsvisning af HTML.
  • Stavekontrol.

Det er også kompatibelt med:

Installation af Formiko på Ubuntu

For denne artikel vil jeg installer Formiko på Ubuntu 18.04. Vi finder dette program tilgængeligt for Debian og BSD, som vi kan se i dets GitHub-side.

Formiko Vim-projekt

Formiko vim

Requisitos

Før vi fortsætter med installationen, skal det siges, at ifølge deres GitHub-side bliver vi nødt til at gøre det ordne nogle krav som beder programmet om at fungere korrekt, når vi installerer det med pip3.

  • python 2.7 eller 3
  • GTK+3
  • gobject-introspektion
  • PyGObject
  • web kit
  • GtkSourceView

Vi åbner en terminal (Ctrl + Alt + T) og skriver:

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

Jeg vil gerne afklare igen, at jeg laver denne installation på Ubuntu 18.04. Når kravene er opfyldt, vil vi se det installationen af ​​programmet sker via pip eller apt som vi er interesserede. Til brug pip3 i installationen skriver vi i terminalen (Ctrl + Alt + T):

pip3 install formiko

Hvis du foretrækker det brug apt, i den samme terminal skriver vi:

apt formiko installation

sudo apt update && sudo apt install formiko

Det skal siges, at begge installationer giver os den samme version af programmet. Eventuelt kan vi også installere:

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

Når vi installerer det, tilføjes to poster til applikationsmenuen: Formiko y Formiko vim.

Formiko launcher og Formiko Vim

Vi bliver nødt til at finde den, der bedst passer til vores behov.

Afinstaller Formiko

Da vi har set to installationsmuligheder, vil vi også se to kommandoer til at fjerne programmet fra vores operativsystem.

Den første af kommandoerne er den, der henviser til installationen udført med pip3. For at fjerne programmet skal vi åbne en terminal (Ctrl + Alt + T) og skrive i den:

sudo pip3 uninstall formiko

Nu vil vi se kommandoen til dem, der valgte installation med apt. I en terminal (Ctrl + Alt + T) skriver vi:

sudo apt purge formiko && sudo apt autoremove

Det er måske ikke det bedste af programmerne for dens funktion, men jeg må sige, at Formiko arbejdede uden problemer, mens jeg har testet det. Jeg ønsker ikke at afslutte uden først at tale om, hvad der måske er det største sorte punkt i dette program, the formatbegrænsning som giver os mulighed for at arbejde

Flere oplysninger om dette program kan fås på siden af Projekt GitHub.


Vær den første til at kommentere

Efterlad din kommentar

Din e-mailadresse vil ikke blive offentliggjort. Obligatoriske felter er markeret med *

*

*

  1. Ansvarlig for dataene: Miguel Ángel Gatón
  2. Formålet med dataene: Control SPAM, management af kommentarer.
  3. Legitimering: Dit samtykke
  4. Kommunikation af dataene: Dataene vil ikke blive kommunikeret til tredjemand, undtagen ved juridisk forpligtelse.
  5. Datalagring: Database hostet af Occentus Networks (EU)
  6. Rettigheder: Du kan til enhver tid begrænse, gendanne og slette dine oplysninger.