Skip to content

abntex/limarka

Repository files navigation

O que é o limarka?

O limarka é uma ferramenta que possibilita o usuário escrever o seu trabalho de conclusão de curso (monografia, dissertação ou teste) em Markdown e produzir PDFs em conformidade com as normas da ABNT.

Gem Version

Por que escrever em Markdown ao invés de Latex?

O LaTeX é ótimo e bastante útil para quem deseja percorrer uma carreira de Pesquisador. Muitos journals disponibilizam modelos somente em LaTeX para produção de artigos, aprender LaTeX irá ser útil nessa carreira.

Mas se você não pretende utilizar LaTeX após a conclusão do seu curso, por que investir na longa curva de aprendizado do LaTeX?

Markdown como alternativa de aprendizado

Com o limarka você agora possui outra alternativa de investimento: aprender Markdown (que é bastante simples).

O Markdown é uma linguagem simples de marcação. Os princípios das linguagem simples de marcação estão sendo popularizados em diversas ferramentas de interação social, veja alguns exemplos: Github, Moodle, WhatsApp, Facebook Google Plus, Jekyll, etc.

Após ou durante conclusão do seu curso, você pretende:

  • Interagir através da escrita em redes sociais ou fóruns de discussão?
  • Editar Wikis ou formatar mensagens?
  • Participar em projetos no Github?
  • Escrever documentações de softwares?
  • Gerar código HTML a partir de texto?
  • Elaborar ebooks?

Se você respondeu afirmativamente a algumas dessas perguntas, aprender uma linguagem simples de marcação (como o Markdown) é um investimento rentável.

OBS: A implementação atual do limarka ainda exige conhecimentos mínimos do Latex.

Qual a relação do limarka com o abnTeX?

O abnTeX provém uma suíte para LaTeX que atende os requisitos das normas da ABNT (Associação Brasileira de Normas Técnicas) para elaboração de trabalhos acadêmicos como teses, dissertações, projetos de pesquisa e outros documentos do gênero.

O limarka converte os textos produzidos em Markdown para LaTeX, utilizando os modelos do abnTeX2 (que são extensivamente testados e incrementados pela comunidade nacional), produzindo um PDF em conformidade com as Normas da ABNT. O limarka é um projeto pertencente ao grupo do abnTeX.

Funcionalidades

  • Utilização da linguagem Markdown para escrita do texto;
  • Configurações através de formulário PDF ou arquivo YAML;
  • Possibilidade de inclusão de códigos Latex;
  • Facilidade para geração de códigos para inclusão de Figuras, Tabelas, Referências e Citações;
  • Facilidade em edição ou personalização de templates;
  • Facilidade de obter suporte ao código Latex gerado (compatível com o estilo do abnTeX2);

Documentação

A documentação do limarka será mantida no wiki do projeto.

  • Vídeos -- recomendo assistir em velocidade rápida

Contribua participando da pesquisa sobre o limarka

O projeto tem como origem uma pesquisa científica (em andamento) sobre utilização de linguagem de marcação de texto para elaboração de monografias.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/abntex/limarka. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.