asciidoctor ghpages action
v2.3.0 :: Support git-lfs repos
Uma ação do GitHub que constrói páginas de Github asciidoc no seu fluxo de trabalho de IC. Ele converte recursivamente todos os arquivos adoc em html , renomeando README.html resultante em index.html Em seguida, pressionando todos os arquivos HTML gerados e existentes para a filial gh-pages . Se você não precisar de nada sofisticado como a antora, essa ação pode ser o caminho a seguir para publicar um site de asciidoc simples. Mas se você precisar de um site mais estruturado, talvez o Jekyll Asciidoc QuickStart seja para você.
Depois de configurar a ação, suas páginas do Github estarão disponíveis em http://your-username.github.io/your-repository .
Lembre-se de que toda vez que a ação é executada, o ramo gh-pages é eliminado. Se você adicionar qualquer coisa manualmente, fora do fluxo de trabalho do IC, o conteúdo será perdido. |
Provemos nosso próprio medicamento publicando este repositório nas páginas do GitHub.
Você precisa apenas adicionar a ação ao seu arquivo de fluxo de trabalho YML e é isso. Opcionalmente, você pode personalizar a compilação dando parâmetros extras à ação, que será entregue à ferramenta Asciidoctor.
Você pode verificar um arquivo de fluxo de trabalho completo aqui. Se você não quiser usar a interface de ação do GitHub e apenas copiar esse arquivo para o mesmo local dentro do seu repositório, ele pode funcionar fora da caixa.
Se você receber o erro "Remoto: permissão para git negado às ações do githubs [bot]", acessar Settings > Actions > General e selecionar Read and write permissions .
A ação permite ativar a geração automática de um arquivo ebook.pdf dos arquivos ASCIIDOC. O PDF também é empurrado para o ramo gh-pages . Para ativar isso, basta adicionar a seguinte configuração:
pdf_build : trueUm exemplo de e -book em PDF está disponível aqui.
Você também pode construir o Asciidoctor Revel.js Slides com esta ação. Isso gerará um arquivo slides.html na ramificação gh-pages . Você pode usar a seguinte configuração para isso:
slides_build: boolean - permite a construção de um arquivo slides.html (padrão false)
slides_main_adoc_file: string - define o nome do arquivo de origem asciidoc para criar os slides (padrão 'readme'). Não inclua a extensão do arquivo.
slides_skip_asciidoctor_build: boolean - para permitir o skippig da construção de arquivos HTML regulares usando o comando asidoctor, se você deseja apenas gerar os slides (padrão false)
Se você deseja verificar como criar um site a partir de vários documentos ASCIIDOC, verifique este repositório de amostra. É apenas em português, mas você pode obter a estrutura.
A ação é simples, mas, para mostrar como você pode criar um site com várias páginas de diferentes arquivos ASCIIDOC, os detalhes são fornecidos aqui em uma página separada. E perceba o link acima aponta para: (i) arquivo adoc ao abrir esta página do repositório do GitHub e (ii) arquivo html ao abrir esta página nas páginas do Github.
As páginas do GitHub precisam de um arquivo CNAME na filial de gh-pages . Mas em todas as ações executadas, o ramo gh-pages é eliminado. Para fazer um domínio personalizado funcionar, basta adicionar o arquivo CNAME no diretório raiz da sua ramificação main ou master e ele será copiado para a filial gh-pages automaticamente. Se você tiver um source_dir , o arquivo CNAME deve estar dentro do seu source_dir configurado.
