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

Про формико

У наступній статті ми збираємось поглянути на Formiko. Це невеликий редактор, побудований на 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.

Загальна характеристика Форміко

foriko gtk

Форміко

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

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

Він також сумісний з:

Встановлення Formiko на Ubuntu

Для цієї статті я буду встановіть Formiko на Ubuntu 18.04. Ми знайдемо цю програму, доступну для Debian та BSD, як ми можемо бачити в її Сторінка GitHub.

Проект Formiko Vim

Форміко вим

Вимога

Перш ніж продовжувати встановлення, слід сказати, що відповідно до їх сторінки 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, в тому ж терміналі ми пишемо:

влучна установка formiko

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. Права: Ви можете будь-коли обмежити, відновити та видалити свою інформацію.