top-right

Automatização e padronização da escrita acadêmica com Limarka e Marp: Um estudo de caso para o IFS

AUTOR: Reinan Gabriel Dos Santos Souza
ORIENTADOR: Prof. Dr. Gilson Pereira Dos Santos Junior
COORIENTADOR: Prof. MSc. Francisco Rodrigues Santos

26 de setembro de 2024
Sumário
  • Problema
  • Objetivo geral
  • Objetivos específicos
  • Solução
  • Resultados
  • Conclusão
  • Trabalhos futuros
  • Principais referências
PROBLEMA
  1. Complexidade na formatação de trabalhos acadêmicos;
  2. Limitações nas ferramentas de escrita acadêmica;
  3. Dificuldades na criação de apresentações acadêmicas;
  4. Falta de integração entre ferramentas de escrita e apresentação;
  5. Carência de automatização no processo de elaboração de trabalhos acadêmicos.
OBJETIVO GERAL

Desenvolver e implementar um template para trabalhos acadêmicos utilizando o Limarka e Marp.

Limarka: https://github.com/abntex/limarka
Marp: https://marp.app/

OBJETIVOS ESPECÍFICOS
  1. Comparar diferentes ferramentas de escrita acadêmica;
  2. Integrar o Limarka e o Marp ao ambiente de desenvolvimento;
  3. Desenvolver um tema personalizado para o Marp;
  4. Implementar uma pipeline para automatizar a compilação e publicação.
SOLUÇÃO

center

Fonte: Autor, (2024).

OS ALUNOS ABREM SOLICITAÇÕES DE MESCLAGEM

center

Fonte: Autor, (2024).

IMPLEMENTAÇÃO DE UM COMMAND-LINE INTERFACE (CLI)

center

Fonte: Autor, (2024).

RESULTADOS DA NOVA CAMADA DE CLI

center

Fonte: Autor, (2024).

# Introdução
@import('article/introducao/contextualizacao.md')

Fonte: Autor, (2024).

agradecimentos: '@import(pages/agradecimentos.md)'

Fonte: Autor, (2024).

PIPELINE PARA AUTOMATIZAR A COMPILAÇÃO E PUBLICAÇÃO

center

Fonte: Autor, (2024).

Link para a pipeline: https://github.com/ReinanHS/limarka-template-tcc/actions/runs/10801707397

RESULTADO DA PÁGINA DE PUBLICAÇÃO GERADO PELO CI/CD

center

Fonte: Autor, (2024).

Link para a página: https://reinanhs.github.io/tcc-bsi-ifs/
Link para o Limarka Page: https://github.com/ReinanHS/limarka-render-html

RESULTADO DA CRIAÇÃO DO TEMA ACADÊMICO PARA O MARP

center

Fonte: Autor, (2024).

RESULTADO DA UTILIZAÇÃO DO VISUAL STUDIO CODE

center

Fonte: Autor, (2024).

RESULTADO DA COMPILAÇÃO DO MARKDOWN EM PDF

center

Fonte: Autor, (2024).

RESULTADO DA CRIAÇÃO DO DIRETÓRIO DOCS

center

Fonte: Autor, (2024).

Novo modelo: https://reinanhs.github.io/limarka-template-docs/
Modelo original: https://github.com/abntex/limarka/wiki/

CONCLUSÃO
  • Facilidade e automação no processo de escrita acadêmica.
  • Integração de ferramentas e simplificação do fluxo de trabalho.
  • Otimização de tempo e recursos com CI/CD.
  • Contribuição para o aprendizado dos alunos.
  • Documentação e suporte acessíveis.
TRABALHOS FUTUROS
  • Expansão da compatibilidade para outras normas acadêmicas.
  • Adaptação para outros cursos e áreas de conhecimento.
  • Estudo sobre a aceitação e impacto da ferramenta entre estudantes.
  • Realizar a implementação de novas validações no CI.
  • Reduzir o tempo de compilação de documentos.
PRINCIPAIS REFERÊNCIAS

LOGAN, D.; SELHORN, S.; TACKER, S. Five fast facts about docs as code at GitLab. 2022. Disponível em: https://about.gitlab.com/blog/2022/10/12/five-fast-facts-about-docs-as-code-at-gitlab. Acesso em: 14 ago. 2024.

SHIEBER, S. M. Why scholars should write in markdown. Harvard University, 2014. Disponível em: https://archive.blogs.harvard.edu/pamphlet/files/2014/08/markdownpost-amsart.pdf. Acesso em: 15 ago. 2024.