/p5.js-website

p5.js website built using Node.js, Grunt, YAML and Assemble

Primary LanguageJavaScriptMIT LicenseMIT

Build Status

p5js website

Introdução a versão brasileira

Parte do site do p5.js está sendo traduzida pelo projeto Internacionalização e popularização do p5.js para falantes de português, desenvolvido por @mardefronteira, @jlbrsl, @katzesoundz e @araucarialab, durante o programa de Fellowship da Processing Foundation de 2021. Neste projeto, nos comprometemos a traduzir a referência, portanto, caso queira contribuir, os exemplos são um bom lugar para começar. Você pode colaborar com correções, sugestões e outras traduções através do GitHub issues deste repositório. As diretrizes de tradução se encontram aqui.

⚠️ Antes de iniciar uma tradução, por favor abra um issue para avisar a comunidade da parte que você pretende traduzir. Dessa maneira outros podem colaborar e evitamos repetir traduções.

Padronização de commits

Para facilitar a compreensão, estamos identificando os commits nesse repositório desta maneira:

  • tradução:
    🇧🇷 área: função, função, função
    🇧🇷 área: nome do exemplo

  • outros:
    🚮 limpeza do código
    🐛 correção de bugs

Redes sociais do projeto

🐦 Twitter: @p5jsbrasil
📸 Instagram: @p5jsbrasil


Colaboradores da versão brasileira

@mardefronteira
@jlbrsl
@katzesoundz
@araucarialab
@tiagohermano


Tradução do ReadME original

Como contribuir

Bugs já conhecidos e intenções de novas funções são monitorados usando o GitHub issues. Se você quer começar a trabalhar em um issue deixe um comentário no issue que você pretende trabalhar para que outros colaboradores saibam que esse problema está sendo resolvido e possam oferecer ajuda. Assim que você terminar de resolver esse issue, faça um pull request (PR) (em português: pedido para incorporar) ao branch principal do p5.js. No campo de descrição do PR inclua "resolves #XXXX" (em português: "resolve o issue número #XXXX"), marcando o issue que você está consertando. Se o PR não resolve o issue por completo você pode colocar a descrição como "addresses #XXXX" (em português: "referente ao issue número #XXXX").

Se você descobrir um bug ou tem uma ideia para uma nova função que você gostaria de adicionar, comece abrindo um issue. Por favor não faça um pull request contendo a resolução do bug ou a nova função sem abrir um issue antes, nós provavelmente não vamos aceitar o PR. Assim que você tiver alguma resposta sobre o issue e uma autorização para resolvê-lo você pode seguir o processo descrito acima para resolver o bug ou adicionar a nova função.

Nós reconhecemos todos os tipos de contribuição. Esse projeto segue a especificação tipo all-contributors. Você pode adicionar a si mesmo no p5.js repository readme seguindo essas instruções!

Configurações para visualização off-line do site

  1. Veja se o Java está instalado. Não está? Visite https://java.oracle.com
  2. Instale o node.js.
  3. Clone este repositório.
  4. Vá até a pasta p5.js-website pelo terminal e digite npm install.

Visualizando o site off-line

Assim que você tiver configurado o site, digite npm run watch para rodar o site. Isso deve abrir uma nova janela no seu browser com o site rodando no endereço http://localhost:9000.

Estrutura de arquivos

  • Veja a not sobre o que incluir nos pull requests aqui.
  • src/ – Todas as peças para gerar o site. Alterações devem ser feitas aqui.
    • assets/ – Todos os arquivos fixos (imgs, css, fonts, js, p5_featured homepage sketches)
      • Observação: se você fizer alterações aqui você deve reiniciar o servidor para ver as mudanças. Para ver as mudanças imediatamente você pode editar os arquivos asset na pasta dist mas precisa copiar e colar suas alterações aqui para que sejam salvas.
    • data/ – arquivos para traduções.
    • templates/
      • layouts/ – default.hbs é o template da página principal.
      • pages/ – Contém cada uma das páginas do site do p5, estas são inseridas com a tag {{> body }} no layout padrão. Note que em algumas páginas (por exemplo: learn, teach e libraries) os arquivos hbs são construídos de arquivos ejs que estão na pasta data/. Quando esse for o caso você encontrará um arquivo README dentro da pasta com instruções de como eles funcionam.
      • partials/ – Estas são partes reutilizáveis que podem ser inseridas em qualquer página ou layout. Elas correspondem a outra tag {{> filename }} nas páginas ou no layout padrão.
  • dist/ – É onde as páginas geradas são armazenadas. Estas são geradas via grunt server mas não são adicionadas ao pull request por se construírem sozinhas online.
  • Gruntfile.js – Este arquivo contém todas as tarefas para usar o Assemble e os para os YAML usados no site final. Ele usa o taskrunner grunt.

Ferramentas

  • Assemble é usado para gerar ao website a partir dos layouts e dos arquivos yml.
  • grunt-assemble-i18n gera um conjunto de páginas para cada língua especificada no gruntfile baseadas nos templates e nos arquivos yml. A documentação é limitada mas este examplo demonstra bem a sua funcionalidade.
  • assemble-contrib-permalinks nos permite customizar os permalinks (estrutura de arquivos do site).

Adicione a si mesmo como colaborador!

Se você contribuiu com esse website (ou qualquer outra parte do projeto p5.js), adicione a si mesmo aqui. Instruções para fazer isso podem ser encontradas no final dessa seção.

Etc

Externally hosted language versions