Boa maneira de gerenciar código em apresentações para workshop de programação

Question

Atualmente, estou criando um workshop de programação (na verdade, é sobre o OOD, mas isso não deve importar muito).

Eu tenho principalmente dois tipos de recursos:

• slides (HTML / reveal.js)
• projetos de amostra (Java)

Em muitos lugares, o código dos projetos de amostra deve aparecer na apresentação.

O que é uma boa maneira de conseguir isso?

Meus requisitos são

• uma maneira fácil de especificar um snippet de código a ser usado em uma apresentação e o local em que ele deve aparecer

• as alterações no código são refletidas na apresentação automaticamente (executar uma ferramenta de compilação é ok, cortar e colar manualmente o material não é)

• links quebrados (como tentar incorporar um snippet de código que não existe ou marcar um snippet que não seja usado na apresentação deve criar um aviso

• Pontos de bônus por ter links entre o código e a apresentação

Answer 1

O link do Asciidoctor pode resolver a maioria dos seus requisitos:

• use ASCII simples para escrever o conteúdo
• inclua snippets de código de arquivos de código-fonte reais
• links quebrados criarão um aviso ao criar a saída
• criou apresentações em reveal.js e deck.js

Você encontrará em link alguns exemplos de como usar o Asciidoctor com gradle (mas outras ferramentas de construção funcionam como bem).

Você pode navegar pelo resultado da amostra aqui e você encontrará uma apresentação renderizada com o deck.js e reveal.js (procure os sub-capítulos 3.4 e 9.4 etiquetados como "Saídas")

Outra fonte de inspiração pode ser o conjunto de decks de Dan Allan: link

Você também solicitou links do código para a apresentação. O melhor Asciidoctor pode fornecer-lhe AFAIK é que a tag que você usou para marcar seu snippet de código no código ( // tag::XXX[] ) também estará presente na fonte da sua apresentação ( include::Class.java[tags=XXX] )