Formiko, um editor reStructuredText para documentação Python

Formiko é mais do que um simples editor de reduções. Com reStructuredText, é extremamente útil na criação de documentação técnica para programas Python.

Formiko, um editor reStructuredText para documentação Python

Hoje, vamos dar uma olhada rápida no pequeno editor construído com Python que recentemente tomei conhecimento.

Conheça a Formiga

Ant rstructuredtext and markdown editor

Recentemente, descobri Formiko enquanto navegava no Google Plus. (Sim, ainda há algumas pessoas nessa plataforma.) Formiko é um editor de reStructuredText e Markdown. Já que escrevo a maior parte do tempo em Markdown, decidi dar uma olhada e ver se poderia ser adicionado à nossa lista de melhores editores de markdown. Também me deu a chance de aprender uma linguagem de marcação diferente.

De acordo com a página do GitHub do projeto, o Formiko inclui os seguintes recursos:

  • Editor baseado em GtkSourceView com destaque de sintaxe
  • Editor Vim
  • Divisão de janela vertical ou horizontal
  • Modo de pré-visualização
  • Arquivo de salvamento periódico
  • JSON e visualização de HTML
  • Verificação ortográfica

Ele também oferece suporte aos seguintes escritores e analisadores:

Nota interessante: Formiko é Esperanto para formiga.

O que é reStructuredText?

Tenho certeza de que há várias pessoas que nunca ouviram falar de reStructuredText. Eu certamente não sabia antes de descobrir o Formiko. reStructuredText faz parte do projeto Docutils. reStructuredText é usado por programadores Python para criar documentação técnica.

Qual é a diferença entre reStructuredText e Markdown? Bem, ambos Markdown e reStructuredText têm recursos de estilo e hiperlink semelhantes. No entanto, como reStructuredText foi projetado para criar documentação, ele oferece suporte a notas de fim, tabelas e notas de rodapé. Vanilla Markdown não suporta tabelas nativamente, mas outras variantes sim.

Reflexões sobre o uso do Formiko

Instalei o Formiko no Ubuntu Budgie 18.04. Estava no repositório, então essa parte era indolor. Depois de instalado, foram adicionados dois itens ao menu do aplicativo: Formiko e Formiko Vim. Quando cliquei no Formiko Vim, o aplicativo abriu, mas a janela de edição estava inutilizável e uma janela de erro apareceu informando que o Ubuntu havia encontrado um erro.

Uma coisa que me irritou quando usei o Formiko foi que o painel de visualização ficava em branco até que eu salvasse o arquivo. Talvez tivesse algo a ver com o fato de que não sabia se eu estava usando reStructuredText ou Markdown até que o arquivo foi criado.

Outra coisa que não gostei foi que você só pode exportar seu trabalho para arquivos HTML. Meu editor Markdown de escolha ghostwriter usando Pandoc, para que você possa exportar para vários formatos diferentes, incluindo .doc, .odt e .epub. Isso é útil para mim.

Uma coisa que direi é que Fomriko funcionou muito bem. Alguém comentou na web que teve um desempenho melhor porque não era baseado no Electron. Embora eu não tenha nada a escolher com o Electron (eu uso o Visual Studio Code afinal), é bom ter desempenho nativo.

Formiko está disponível no Linux e BSD. Não é um pequeno aplicativo ruim, mas vou ficar com o que tenho.

Você já usou Formiko? Qual é o seu editor reStructuredText ou Markdown favorito? Deixe-nos saber nos comentários abaixo.

Se você achou este artigo interessante, reserve um minuto para compartilhá-lo nas redes sociais.

Via itsfoss.com. Você pode conferir o post original em inglês:

Formiko, a reStructuredText Editor for Python Documentation

Última atualização deste artigo: 9 de november de 2019