Formiko, структуриран текстов редактор за документация на Python

Относно формико

В следващата статия ще разгледаме Формико. Това е малък редактор, изграден с Python, който случайно намерих в GitHub. Формико е приложение reStructuredText с MarkDown редактор и визуализация за проверка на напредъка на свършената работа.

ReStructuredText е част от проекта Docutils и се използва от програмистите на Python за създаване на техническа документация. Сигурен съм, че ще има много хора, които никога не са чували за reStructuredText, но чрез тази програма и някои основни понятия ще видите, че е лесно да се използва тази синтаксисна система. Програмата е написана на Python с Gtk3, GtkSourceView и Webkit2. Използвайте Docutils и повторно отбелязване на Common Mark Parser.

Трябва да се каже, че Markdown и reStructuredText имат подобни възможности. Като разлика трябва да се отбележи, че reStructuredText е предназначен за създаване на документация, поддържа таблици и бележки под линия и бележки под линия.

ReStructuredText е лесна за четене система за парсер и синтаксис. Полезен е за онлайн програмна документация, низове на документи на Python, за бързо създаване на прости уеб страници и за самостоятелни документи. Анализаторът reStructuredText е компонент на Docutils и представлява ревизия и интерпретация на леките маркиращи системи StructuredText и Setext.

Обща характеристика на Формико

формико gtk

Формико

Според страницата на проекта GitHub, Formiko включва следните функции:

  • Позирах редактор, базиран на GtkSourceView с подчертаване на синтаксиса и редактор на Vim.
  • Ние отиваме разделете работната зона вертикално или хоризонтално.
  • Предлага a режим на предварителен преглед за да видите как е работата.
  • JSON и визуализация на HTML.
  • Проверка на правописа.

Също така е съвместим със:

Инсталиране на Formiko на Ubuntu

За тази статия ще го направя инсталирайте Formiko на Ubuntu 18.04. Ще намерим тази програма достъпна за Debian и BSD, както можем да видим в нейната Страница на GitHub.

Проект Формико Вим

Формико вим

Изисквания

Преди да пристъпите към инсталацията, трябва да се каже, че според тяхната страница на GitHub ще трябва поправете някои изисквания което иска програмата да функционира правилно, когато я инсталираме с pip3.

  • python 2.7 или 3
  • GTK+3
  • gobject-интроспекция
  • PyGObject
  • уеб комплект
  • GtkSourceView

Отваряме терминал (Ctrl + Alt + T) и записваме:

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

Искам отново да поясня, че правя тази инсталация на Ubuntu 18.04. След като изискванията бъдат изпълнени, ще видим това инсталирането на програмата ще се извърши чрез pip или apt както ни интересува. За използвайте pip3 в инсталацията ще напишем в терминала (Ctrl + Alt + T):

pip3 install formiko

В случай, че предпочитате използвайте apt, в същия терминал пишем:

подходяща формако инсталация

sudo apt update && sudo apt install formiko

Трябва да се каже, че и двете инсталации ще ни предоставят една и съща версия на програмата. По желание можем да инсталираме и:

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

Когато го инсталираме, в менюто на приложението ще бъдат добавени два записа: Формико y Формико вим.

Formiko стартер и Formiko Vim

Ще трябва да намерим този, който най-добре отговаря на нашите нужди.

Деинсталирайте Formiko

Тъй като видяхме две опции за инсталиране, ще видим и две команди за премахване на програмата от нашата операционна система.

Първата от командите ще бъде тази, отнасяща се до инсталацията е извършена с pip3. За да премахнем програмата, ще отворим терминал (Ctrl + Alt + T) и ще напишем в него:

sudo pip3 uninstall formiko

Сега ще видим командата за тези, които са избрали инсталация с апт. В терминал (Ctrl + Alt + T) пишем:

sudo apt purge formiko && sudo apt autoremove

Може да не е най-добрата от програмите за нейната функция, но трябва да кажа, че Formiko работеше без проблеми, докато я тествах. Не искам да завърша, без първо да говоря за това, което е може би най-голямата черна точка на тази програма, ограничение на формата с което ни позволява да работим

Повече информация за тази програма можете да получите на страницата на Проект GitHub.


Оставете вашия коментар

Вашият имейл адрес няма да бъде публикуван. Задължителните полета са отбелязани с *

*

*

  1. Отговорен за данните: Мигел Анхел Гатон
  2. Предназначение на данните: Контрол на СПАМ, управление на коментари.
  3. Легитимация: Вашето съгласие
  4. Съобщаване на данните: Данните няма да бъдат съобщени на трети страни, освен по законово задължение.
  5. Съхранение на данни: База данни, хоствана от Occentus Networks (ЕС)
  6. Права: По всяко време можете да ограничите, възстановите и изтриете информацията си.