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

О Formiko

В следующей статье мы рассмотрим Formiko. Это небольшой редактор, построенный на Python, который я случайно нашел на GitHub. Формико приложение ReStructuredText с редактором MarkDown и предварительным просмотром для проверки хода проделанной работы.

ReStructuredText - это часть проекта Docutils и используется программистами Python для создания технической документации. Я уверен, что найдется много людей, которые никогда не слышали о reStructuredText, но благодаря этой программе и некоторым базовым концепциям вы увидите, что эту систему синтаксиса легко использовать. Программа написана на Python с использованием Gtk3, GtkSourceView и Webkit2. Используйте Docutils и рекомендовать Common Mark Parser.

Надо сказать, что уценка и reStructuredText имеют аналогичные возможности. В качестве отличия следует отметить, что reStructuredText предназначен для создания документации, поддерживает таблицы, сноски и концевые сноски.

ReStructuredText - это легкая для чтения система синтаксического анализа и синтаксиса. Он полезен для интерактивной программной документации, строк документов Python, для быстрого создания простых веб-страниц и для автономных документов. Парсер reStructuredText является компонентом Docutils и представляет собой пересмотр и переосмысление облегченных систем разметки StructuredText и Setext.

Общие характеристики Formiko

Formiko GTK

Формико

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

  • Я создал редактор на основе GtkSourceView с подсветка синтаксиса и редактор Vim.
  • Мы идем разделить рабочую зону вертикально или горизонтально.
  • Предлагает режим предварительного просмотра чтобы посмотреть, как идет работа.
  • JSON и предварительный просмотр HTML.
  • Проверка орфографии.

Он также совместим с:

Установка Formiko на Ubuntu

В этой статье я буду установить Formiko на Ubuntu 18.04. Мы найдем эту программу доступной для Debian и BSD, как мы видим в ее Страница GitHub.

Проект Formiko Vim

Formiko vim

Реквизиты

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

  • python 2.7 или 3
  • ГТК + 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, в этом же терминале пишем:

установка apt formiko

sudo apt update && sudo apt install formiko

Надо сказать, что обе установки предоставят нам одну и ту же версию программы. По желанию мы также можем установить:

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

Когда мы его установим, в меню приложения будут добавлены две записи: Формико y Formiko vim.

Formiko launcher и Formiko Vim

Нам нужно будет найти тот, который лучше всего соответствует нашим потребностям.

Удалить Formiko

Поскольку мы видели два варианта установки, мы также увидим две команды для удаления программы из нашей операционной системы.

Первая из команд будет относиться к установка сделана с помощью pip3. Чтобы удалить программу, мы собираемся открыть терминал (Ctrl + Alt + T) и написать в нем:

sudo pip3 uninstall formiko

Теперь мы увидим команду для тех, кто выбрал установка с apt. В терминале (Ctrl + Alt + T) пишем:

sudo apt purge formiko && sudo apt autoremove

Возможно, это не лучшая программа по своей функции, но я должен сказать, что Formiko работала без каких-либо проблем, пока я ее тестировал. Я не хочу заканчивать, не рассказав сначала о том, что, возможно, является самой большой черной точкой этой программы, - ограничение формата с чем позволяет нам работать

Более подробную информацию об этой программе можно получить на странице Проект GitHub.


Будьте первым, чтобы комментировать

Оставьте свой комментарий

Ваш электронный адрес не будет опубликован. Обязательные для заполнения поля помечены *

*

*

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