Formiko, een gestructureerde teksteditor voor Python-documentatie

Over Formiko

In het volgende artikel gaan we Formiko bekijken. Dit is een kleine editor gebouwd met Python die ik toevallig tegenkwam op GitHub. Formiko is een aanvraag reStructuredText met een MarkDown-editor en preview om de voortgang van het uitgevoerde werk te controleren.

ReStructuredText is onderdeel van het Docutils-project en wordt gebruikt door Python-programmeurs om technische documentatie te maken. Ik weet zeker dat er veel mensen zullen zijn die nog nooit van reStructuredText hebben gehoord, maar door dit programma en enkele basisconcepten zul je zien dat het gemakkelijk is om dit syntaxis-systeem te gebruiken. Het programma is geschreven in Python met Gtk3, GtkSourceView en Webkit2. Gebruik Docutils en adviseer Common Mark Parser.

Dat moet gezegd worden Markdown en reStructuredText hebben vergelijkbare mogelijkheden​ Als een verschil moet worden opgemerkt dat reStructuredText is ontworpen om documentatie te maken, het ondersteunt tabellen en voetnoten en eindnoten.

ReStructuredText is een gemakkelijk te lezen parser en syntaxis-systeem. Het is handig voor online programmadocumentatie, Python-documentreeksen, voor het snel maken van eenvoudige webpagina's en voor zelfstandige documenten. De reStructuredText parser is een component van Docutils en is een herziening en herinterpretatie van de StructuredText en Setext lichtgewicht markup systemen.

Algemene kenmerken van Formiko

foriko gtk

Formiko

Volgens de GitHub-pagina van het project bevat Formiko de volgende functies:

  • Ik poseerde een editor op basis van GtkSourceView met syntaxisaccentuering en een Vim-editor.
  • We gaan verdeel het werkgebied verticaal of horizontaal.
  • Biedt een voorbeeldmodus om te zien hoe het werk is.
  • JSON en preview van HTML.
  • Spellingscontrole.

Het is ook compatibel met:

Formiko installeren op Ubuntu

Voor dit artikel zal ik installeer Formiko op Ubuntu 18.04​ We zullen dit programma beschikbaar vinden voor Debian en BSD, zoals we kunnen zien in het GitHub-pagina.

Formiko Vim-project

Formiko vim

Eisen

Voordat we doorgaan met de installatie, moet worden gezegd dat we, zoals vermeld op hun GitHub-pagina, repareer wat vereisten die het programma vraagt ​​om correct te functioneren wanneer we het installeren met pip3.

  • python 2.7 of 3
  • GTK+3
  • gobject-introspectie
  • PyGO-object
  • webkit
  • GtkSourceView

We openen een terminal (Ctrl + Alt + T) en schrijven:

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

Ik wil nogmaals verduidelijken dat ik deze installatie doe op Ubuntu 18.04. Als eenmaal aan de vereisten is voldaan, zullen we dat zien de installatie van het programma zal gebeuren via pip of apt zoals we geïnteresseerd zijn. Voor gebruik pip3 in de installatie zullen we in de terminal schrijven (Ctrl + Alt + T):

pip3 install formiko

Voor het geval u dat verkiest gebruik apt, in dezelfde terminal schrijven we:

apt formiko installatie

sudo apt update && sudo apt install formiko

Het moet gezegd worden dat beide installaties ons dezelfde versie van het programma zullen leveren. Optioneel kunnen we ook installeren:

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

Wanneer we het installeren, worden er twee items aan het applicatiemenu toegevoegd: Formiko y Formiko vim.

Formiko-draagraket en Formiko Vim

We zullen degene moeten vinden die het beste bij onze behoeften past.

Verwijder Formiko

Omdat we twee installatie-opties hebben gezien, zullen we ook twee opdrachten zien om het programma van ons besturingssysteem te verwijderen.

De eerste van de opdrachten is degene die verwijst naar de installatie gedaan met pip3​ Om het programma te elimineren, gaan we een terminal openen (Ctrl + Alt + T) en erin schrijven:

sudo pip3 uninstall formiko

Nu zullen we het commando zien voor degenen die het installatie met apt​ In een terminal (Ctrl + Alt + T) schrijven we:

sudo apt purge formiko && sudo apt autoremove

Het is misschien niet de beste van de programma's vanwege zijn functie, maar ik moet zeggen dat Formiko zonder problemen werkte terwijl ik het heb getest. Ik wil niet eindigen zonder eerst te praten over wat misschien wel het grootste zwarte punt van dit programma is, de formaatbeperking waarmee we kunnen werken

Meer informatie over dit programma is te vinden op de pagina van Project GitHub.


Laat je reactie achter

Uw e-mailadres wordt niet gepubliceerd. Verplichte velden zijn gemarkeerd met *

*

*

  1. Verantwoordelijk voor de gegevens: Miguel Ángel Gatón
  2. Doel van de gegevens: Controle SPAM, commentaarbeheer.
  3. Legitimatie: uw toestemming
  4. Mededeling van de gegevens: De gegevens worden niet aan derden meegedeeld, behalve op grond van wettelijke verplichting.
  5. Gegevensopslag: database gehost door Occentus Networks (EU)
  6. Rechten: u kunt uw gegevens op elk moment beperken, herstellen en verwijderen.