Formiko, strukturalny edytor tekstu do dokumentacji Pythona

O formiko

W następnym artykule przyjrzymy się Formiko. To mały edytor zbudowany w Pythonie, który znalazłem przypadkowo na GitHubie. Formiko jest wniosek reStructuredText z edytorem MarkDown i podglądem sprawdzić postęp wykonanej pracy.

ReStructuredText jest część projektu Docutils i jest używany przez programistów Pythona do tworzenia dokumentacji technicznej. Jestem pewien, że będzie wielu ludzi, którzy nigdy nie słyszeli o reStructuredText, ale dzięki temu programowi i kilku podstawowym pojęciom zobaczysz, że korzystanie z tego systemu składni jest łatwe. Program jest napisany w Pythonie z Gtk3, GtkSourceView i Webkit2. Użyj Docutils i zalecam markę Common Mark Parser.

Trzeba to powiedzieć Obniżka cen i reStructuredText mają podobne możliwości. Jako różnicę należy zauważyć, że reStructuredText jest przeznaczony do tworzenia dokumentacji, obsługuje tabele i przypisy oraz przypisy końcowe.

ReStructuredText to łatwy do odczytania parser i system składni. Jest to przydatne w przypadku dokumentacji programów online, ciągów dokumentów w języku Python, szybkiego tworzenia prostych stron internetowych i samodzielnych dokumentów. Parser reStructuredText jest składnikiem Docutils i jest wersją i reinterpretacją lekkich systemów znaczników StructuredText i Setext.

Ogólna charakterystyka Formiko

foriko gtk

Formiko

Według strony GitHub projektu, Formiko zawiera następujące funkcje:

  • Pozowałem edytora opartego na GtkSourceView z podświetlanie składni i edytor Vima.
  • Idziemy podzielić obszar roboczy pionowo lub poziomo.
  • Oferuje a tryb podglądu żeby zobaczyć, jak ci idzie.
  • JSON i podgląd HTML.
  • Sprawdzanie pisowni.

Jest również kompatybilny z:

Instalowanie Formiko na Ubuntu

W tym artykule będę zainstaluj Formiko na Ubuntu 18.04. Znajdziemy ten program dostępny dla Debiana i BSD, jak widać w jego Strona GitHub.

Projekt Formiko Vim

Formiko vim

Wymagania

Przed przystąpieniem do instalacji należy powiedzieć, że zgodnie z ich stroną GitHub będziemy musieli to zrobić naprawić niektóre wymagania która prosi program, aby działał poprawnie, gdy instalujemy go za pomocą pip3.

  • python 2.7 lub 3
  • GTK+3
  • introspekcja gobject
  • PyGOObject
  • zestaw internetowy
  • GtkSourceView

Otwieramy terminal (Ctrl + Alt + T) i piszemy:

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

Chcę jeszcze raz wyjaśnić, że wykonuję tę instalację w systemie Ubuntu 18.04. Gdy wymagania zostaną spełnione, zobaczymy to instalacja programu zostanie wykonana przez pip lub apt jak nas interesuje. Dla użyj pip3 w instalacji napiszemy w terminalu (Ctrl + Alt + T):

pip3 install formiko

Jeśli wolisz użyj apt, w tym samym terminalu piszemy:

apt formiko instalacja

sudo apt update && sudo apt install formiko

Trzeba powiedzieć, że obie instalacje udostępnią nam tę samą wersję programu. Opcjonalnie możemy również zainstalować:

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

Po zainstalowaniu do menu aplikacji zostaną dodane dwa wpisy: Formiko y Formiko vim.

Wyrzutnia Formiko i Formiko Vim

Będziemy musieli znaleźć taki, który najlepiej odpowiada naszym potrzebom.

Odinstaluj Formiko

Jak widzieliśmy dwie opcje instalacji, zobaczymy również dwa polecenia do usunięcia programu z naszego systemu operacyjnego.

Pierwsze z poleceń będzie dotyczyło pliku instalacja wykonana za pomocą pip3. Aby wyeliminować program, otworzymy terminal (Ctrl + Alt + T) i napiszemy w nim:

sudo pip3 uninstall formiko

Teraz zobaczymy polecenie dla tych, którzy wybrali instalacja za pomocą apt. W terminalu (Ctrl + Alt + T) piszemy:

sudo apt purge formiko && sudo apt autoremove

Może nie jest to najlepszy program pod względem funkcji, ale muszę powiedzieć, że Formiko działało bez zarzutu, gdy go testowałem. Nie chcę zakończyć bez wcześniejszego omówienia prawdopodobnie największego czarnego punktu tego programu, czyli ograniczenie formatu z którym możemy pracować

Więcej informacji o tym programie można znaleźć na stronie Projekt GitHub.


Zostaw swój komentarz

Twój adres e-mail nie zostanie opublikowany. Wymagane pola są oznaczone *

*

*

  1. Odpowiedzialny za dane: Miguel Ángel Gatón
  2. Cel danych: kontrola spamu, zarządzanie komentarzami.
  3. Legitymacja: Twoja zgoda
  4. Przekazywanie danych: Dane nie będą przekazywane stronom trzecim, z wyjątkiem obowiązku prawnego.
  5. Przechowywanie danych: baza danych hostowana przez Occentus Networks (UE)
  6. Prawa: w dowolnym momencie możesz ograniczyć, odzyskać i usunąć swoje dane.