Esse repositório é responsável por contém os arquivos do esqueleto (modelo) para iniciar a escrita de um trabalho acadêmico com o limarka. Além disso, este projeto contém várias outras novidades que facilitam a escrita de um trabalho acadêmico.
Provavelmente se você chegou a utilizar o abntex/trabalho-academico-limarka, você encontrou problemas ao configurar o ambiente. Ao usar esse modelo vários problemas serão solucionados.
Principais informações
Durante a criação deste modelo, novos recursos foram adicionados para ajudá-lo a escrever um trabalho acadêmico com maior facilidade. Os principais recurso são:
- Criação de uma ambiente utilizado
docker-composer. - Criação do script
limarka-helpque vai lhe ajudar a fazer o build dos arquivos. - Criação de jobs no Github Action para publicar seus trabalhos e disponibilizar no seu repositório.
- Melhorias na estrutura de arquivos.
- Adicionar nova funcionalidade para importar arquivos markdown.
Veja esse vídeo com uma introdução rápida sobre esse template: Limarka: como escrever um tcc em markdown
A maneira recomendada de instalar este projeto é seguindo estas etapas:
- Realize o clone do projeto para a sua máquina
git clone https://github.com/ReinanHS/limarka-template-tcc.git- Acessar as pastas do projeto
- Certifique se de ter o docker e make instalado em sua maquina
- Execute os seguintes comandos:
cd limarka-template-tcc
make upAtenção: Se você não tiver o comando make instalado em sua máquina, você pode rodar o comando:
docker-compose up
- Você deverá abrir outro terminal e executar o seguinte comando:
make build-docApós fazer e execução desse comando será gerado uma pasta build com o arquivo compilado do seu projeto.
Veja a documentação sobre esse modelo acessando esse link
As principais tecnologias usadas foram:
O limarka é uma ferramenta de comando de linha (sem interface gráfica) que gera PDFs em conformidade com as Normas da ABNT a partir de textos escritos em Markdown.
Essa é a ferramenta base para esse projeto. Você poderá encontrar uma vasta documentação falando sobre essa ferramenta clicando nesse link.
O Docker é uma plataforma open source que facilita a criação e administração de ambientes isolados. Ele possibilita o empacotamento de uma aplicação ou ambiente dentro de um container, se tornando portátil para qualquer outro host que contenha o Docker instalado.
Com o Docker você não presissar se prebupar em configurar um ambiente. Todas essas configurações já foram feitas e estaõ no docker.
Atenção: Para a utilizar esse repositório é recomendado fazer a instalação do docker em sua máquina, veja abaixo algumas links de ajuda:
Esta é uma ferramenta para ajudá-lo a disponibilizar seu trabalho acadêmico em uma página da web. Com esta ferramenta é possível fazer diversas customizações. Além disso, você pode compartilhar o link com outras pessoas para visualizar o seu artigo.
Veja esse exemplo:
Você pode acessar essa página pelo link: https://reinanhs.github.io/limarka-template-tcc/
A página seguite as especificações de metadata do DCMI para ajudar a divulgar o seu artigo e para gerar uma relevância nas pesquisas no Google e em outros buscadores.
Esta ferramenta também irá gerar uma tabela com informações resumidas sobre o seu artigo. Além disso, ela também vai disponibilizar um link para a visualizar seu artigo.
- Botão de compartilhamento redes sociais
- Possibilidade de criar páginas
- Sistema de comentários
- Site responsivo
Caso você queira saber mais sobre essa ferramenta veja essa documentação.
GitHub Actions é uma plataforma de integração contínua e entrega contínua (CI/CD) que permite automatizar a sua compilação, testar e pipeline de implantação.
Com essa ferramente é possivel fazer o build automatizado do artigo acadêmico.
Por favor, veja CHANGELOG para obter mais informações sobre o que mudou recentemente.
Quer fazer parte desse projeto? Clique AQUI e leia como contribuir.
Se você descobrir algum problema relacionado à segurança, envie um e-mail para reinangabriel1520@gmail.com em vez de usar o issue.
Esse projeto está sob licença. Veja o arquivo LICENÇA para mais detalhes.
A logo utilizada nesse projeto, foi retirada do site: Flaticon