A biblioteca open-source revealjs.com é um fremework open-source para criação de apresentações.
Esta biblioteca vem com várias funcionalidades como slides hierárquicos, suporte a markdown, animações, exportar para PDF, notas para o apresentador, LaTeX typesetting, sintaxe para demonstrar código e uma extensiva API.
Este repositório é um clone do repositório original, visando sempre buscar as versões mais atualizadas do mesmo.
Para utilização do repositório necessário realizar a instalação do programa Docker:
# Listar comandos disponíveis
task --list
Inicializa container docker e servidor local
task container
# Criar estrutura de nova apresentação
task presentation <nome_da_nova_apresentação>
Obs.: Ao executar o comando task presentation <nome_da_nova_apresentação>
o nome da nova apresentação deverá ser informada no padrão snaque_small_case
sem caracteres acentuação e ou especiais.
Comandos task presentation <nome_da_nova_apresentação>
realiza modificações/criações de arquivos no repositório, sendo necessário, portanto, posterior commit.
Para criar uma nova apresentação basta rodar o comando task presentation nome_da_nova_apresentação
.
Uma pasta com o nome da apresentação será adicionada em presentations/
.
A nova apresentação deverá ser criada utilizando Markdown no arquivo index.md
.
Regras básicas para montagem da apresentação:
Note:
Adiciona notas que podem ser acessadas com o "speaker view".Este template possui a ferramenta "speaker view".
Ao apertar a tecla "s" uma nova janela será aberta, apenas para o apresentador, com um relógio, preview dos slides e notas (caso elas existam).
O "speaker view" desta apresentação também foi configurado para ajudar na gestão do tempo.
A configuração padrão adotada foi de 3600 segundos (ou uma hora). Caso necessite, esta poderá ser modificada no parâmetro totalTime
ta tag script
do arquivo index.html
de sua apresentação.
<script>
// More info about initialization & config:
// - https://revealjs.com/initialization/
// - https://revealjs.com/config/
Reveal.initialize({
hash: true,
progress: true,
slideNumber: 'c/t',
totalTime: 3600,
// Learn about plugins: https://revealjs.com/plugins/
plugins: [ RevealMarkdown, RevealHighlight, RevealNotes ]
});
</script>
O plugin Mermaid foi instalado no template, devendo a sintaxe abaixo ser utilizada normalmente nos arquivos markdow:
<div class="mermaid">
<pre>
<!-- %%{init: {'theme': 'dark', 'themeVariables': { 'darkMode': true }}}%% -->
flowchart TD
A[Start] --> B;
B[End];
</pre>
</div>
Para entender a sintaxe para escrita de gráficos e fluxogramas com Mermaid consulte a documentação da ferramenta. Diversas opções estão disponíveis, sendo provavelmente o fluxograma o mais utilizado. Para configurar o tema Mermaid (linha <!-- %%{init: {'theme': 'dark', 'themeVariables': { 'darkMode': true }}}%% -->
comentada no script acima) basta acessar, também, a documentação.
Outro plugin instalado foi o menu. Todas as suas funcionalidades podem ser acessadas neste live demo. O arquivo links.html
criado na pasta de todas as apresentações é uma de suas funcionalidades e possibilita a inclusão de links na apresentação. Suas opções podem ser acessadas em um menu sanduíche criado no canto inferior esquerdo das apresentações, não deixe de conferir e experimentar.
As apresentações pode ser salvas em pdf no navegador Google Chrome, bastando acrescentar ?print-pdf
ao final da URL da mesma e utilizando o atalho CTRL+P
para selecionar o local aonde a mesma será salva em sua máquina.
esc
: Visualização de todos os slides.g
: Dá possibilidade de indicar o número do slide que deseja acessar.s
: Acessa página speaker view.Com exceção dos arquivos index.html
e README.md
as demais adaptações no repositório ocorreram em arquivos próprios.
Seguindo orientações deste post Stackoverflow as atualizações deverão ocorrer da seguinte maneira:
# Sem nada para commitar na master
$ git checkout master
# Pull da master
$ git pull origin master
# Fetch upstream
$ git pull upstream master
# Rebase
$ git rebase upstream/master
# git rebase --skip poderá ser utilizado para facilitar o processo
# Caso não acha nenhum conflito - Successfully rebased and updated refs/heads/master.
# Ligar o servidor para testar se nada quebrou
$ task container
# Tudo funcionando realizar o push para origin
$ git push origin master