slides2pages

Implantar Marp nas páginas do GitHub

Apresentações para páginas da Web: Instantaneamente!

O que?

Marp permite criar slides HTML a partir de descontos (assim!).

Esta apresentação é um site e um README.md.

Por que?

Trate sua apresentação da mesma forma que trata o código.

• Use git para rastrear alterações
• Receba solicitações para colaborar
• Implantar automaticamente
• Vê algum problema? Abra um problema!

Configurar

Quer criar o seu próprio?

Primeiro, crie um novo repositório a partir do repositório de modelos.

Configurar páginas do GitHub

Abra seu novo repositório e configure a publicação.

Você normalmente usará gh-pages como branch de implantação.

Revise a versão

Clique na guia Ações e veja se a compilação foi bem-sucedida (pode levar algum tempo).

Agora você deve ver os arquivos gerados no branch gh-pages .

Ver página da web

Abra sua página da web implantada para ver o conteúdo.

Pronto, você deverá ver README.md como /index.html e /README.pdf . Os slides em docs/ também são convertidos.

Executando localmente

• Conversão única sem instalar marp-cli

$ npx @marp-team/marp-cli@latest README.md -o build/README.pdf

---

• Ou instale marp-cli no diretório atual com npm

$ npm install --save-dev @marp-team/marp-cli

• A execução do comando acima cria um arquivo package.json no diretório atual, como este

{
	"devDependencies" : {
		"@marp-team/marp-cli" : " ^4.0.0 "
	}
}

---

• Agora o comando marp está disponível no diretório atual quando prefixado por npx

$ npx marp README.md -o build/README.pdf

• E aqui está a saída

[  INFO ] Converting 1 markdown...
[  INFO ] README.md = > build/README.pdf

---

• Se você já possui o arquivo package.json no diretório atual, simplesmente execute-o para instalar os pacotes especificados por ele.

$ npm install

Como uma etapa do fluxo de trabalho

O fluxo de trabalho executa uma etapa equivalente:

 - name: Marp Build (README.pdf)
  uses: docker://marpteam/marp-cli:v1.7.0
  with:
    args: README.md -o build/README.pdf
  env:
    MARP_USER: root:root

Observe que os args correspondem ao slide anterior.

Personalizando a construção

Qualquer coisa na pasta build/ será implantada nas páginas do GitHub.

Você pode copiar arquivos extras ou executar etapas de processamento adicionais usando outras ferramentas.

Saiba mais sobre Marp

Este é um bom momento para aprender mais sobre o Marp. Aqui estão alguns recursos:

• Marca Comum
• Folha de dicas
• Temas
• Temas CSS
• Diretivas
• Plug-in de código VS
• Editor on-line do Marp

Sites de exemplo

Os sites conhecidos que usam esta ação são:

• CS 199 Even More Practice da Universidade de Illinois em Urbana-Champaign (código)
• Explorando modelos baseados em agente (código)

Envie uma solicitação pull para adicionar seu site.

Publique seus slides

Quando você estiver pronto para compartilhar sua apresentação, confirme ou mescle com main e seu conteúdo nas páginas do GitHub será atualizado automaticamente.

?

Viva!