Template para Elaboração de Material Didático Multimídia com AsciiDoc, git e GitHub
|
❗
|
Você pode baixar uma versão sempre atualizada em PDF deste material aqui. |
Este repositório serve como um template para a criação de material didático multimídia utilizando AsciiDoc e hospedando no GitHub Pages. Ele apresenta instruções de como configurar seu ambiente de desenvolvimento para poder escrever conteúdo em AsciiDoc e publicar no GitHub Pages. Adicionalmente, há um resumo dos comandos AsciiDoc para quem estiver iniciando na produção de conteúdo neste formato.
Assim, utilize este arquivo README.adoc como exemplo pois ele já está configurado. Para criar seu próprio conteúdo, basta apagar o texto neste arquivo e incluir o seu. Quando for criar novos arquivos, basta copiar o README.adoc anterior e iniciar a partir daí.
1. Instalação das Ferramentas no seu Ambiente de Desenvolvimento
Execute o script ferramentas.sh em um terminal com sistema Ubuntu ou qualquer derivado de Debian:
sh ferramentas.shSe sua distribuição for antiga ou não for 64 bits, pode ser que a instalação do Visual Studio code não funcione. Se ocorrer erro, baixe o Visual Studio Code manualmente em http://code.visualstudio.com
Crie uma conta no GitHub em https://github.com/signup. O nome de usuário se torna o link para sua conta pública, como http://github.com/manoelcampos. Por isso, escolha o nome apropriadamente.
Para qualquer alteração em um projeto que você desejar enviar para o GitHub a partir da sua máquina, você precisará informar nome de usuário e senha. Isso se tornará um processo bastante chato e toma tempo. Para evitar isso, na nossa máquina pessoal, podemos configurar a autenticação por meio de um par de chaves pública/privada.
Para isto, siga o tutorial disponível neste vídeo.
2. Comandos AsciiDoc
3. GitHub Pages
O repositório usa a AsciiDoctor GitHub Pages Action para converter cada arquivo adoc para html, enviando tais arquivos para o branch gh-pages. Este processo ocorre automaticamente sempre que um push é executado ou pull request enviada. Com isto, o material estará disponível em um site no GitHub Pages em http://seu-nome-de-usuario.github.io/nome-do-seu-repositorio.
|
❗
|
É necessário incluir o branch gh-pages como fonte de publicação para seu site GitHub Pages nas configurações do seu repositório. Instruções aqui.
|
4. Licença
Este repositório não possui uma licença definida e você pode utilizar o conteúdo dele livremente para criar seu próprio repositório. Assim, não é preciso dar qualquer tipo de crédito por ter utilizado este projeto (a menos que realmente queira).
Você pode utilizar tal repositório como bem desejar, sem qualquer tipo de limitação. No entanto, o repositório é fornecido como está e nenhuma responsabilidade será atribuída ao autor do mesmo.
Ao produzir seu conteúdo multimídia a partir deste respositório, é importante adicionar um arquivo LICENSE e assim definir explicitamente uma licença para o conteúdo que você produzir.