Skip to content

Projetos de actions para gerar documentação automática em um projeto Hugo a partir de repositórios com código markdown

Notifications You must be signed in to change notification settings

LelePG/auto-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Actions Franzininho

Este repositório contém actions para os repositórios da organização Franzininho para que a documentação desses repositórios seja gerada de forma automática.

Tipos de actions

  1. Repositório apenas com exemplos ou exercícios
  2. Repositório de um único projeto com o README na pasta principal

Configurações necessárias para o uso das actions

1. Geração de um token de autenticação

Para gerar um token, é preciso acessar a configuração developer settings no seu perfil de Usuário no Github e gerar um token:

Depois de gerar o Token, é preciso salvá-lo pois ele não será acessível posteriormente

2. Inserir o token como um segredo do repositório onde a action será inserida

Para isso, é preciso acessas as configurações do repositório e acessar a opção secrets and variables e dentro a opção actions

Depois disso, é preciso criar um novo segredo com o nome TOKEN (esse nome é importante, pois é o nome que é referenciado dentro das actions) e atribuir a ele o valor do token gerado no passo anterior.

3. Criação de um projeto Hugo

O próximo passo é criar e configurar um segundo repositório contendo um projeto desenvolvido com o Hugo. Não entrarei em detalhes com relação a esse processo, mas você pode seguir os tutoriais da própria documentação da ferramenta.

4. Configurar a action

Escolha uma das actions disponíveis no repositório e faça a configuração no repositório que você deseja enviar para o site de forma automática. É importante lembrar que existem padronizações a serem seguidas nas nomenclaturas dos arquivos, mas estas são detalhadas nas actions.

About

Projetos de actions para gerar documentação automática em um projeto Hugo a partir de repositórios com código markdown

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published