phpsp.org.br

PHPSP Website

Site estático gerado via Jigsaw;

Duvidas e acompanhamento

Nós contamos com um canal aberto do Slack para tirar dúvidas e discutir problemas e soluções relacionadas ao site do phpsp. Sinta-se livre para acompanhar e participar a qualquer momento através do canal #Site do nosso Slack.

Enviando artigos

• Fazer fork do repositório;
• Adicionar um novo arquivo no formato markdown na pasta source/_posts com o seguinte cabeçalho preenchido:

---
createdAt: YYYY-MM-DD
title: TITULO
author: SEU NOME
authorEmail: SEU EMAIL
---
CONTEÚDO
Lorem ipsum

• Enviar um PR para master com o novo conteúdo;

Convenções e metadados em arquivos markdown

Todo post em .md contém algumas convenções e metadados que você pode aproveitar enquanto escreve seu artigo:

• Gravatar

Através do metadado authorEmail iremos procurar um avatar disponível no site Gravatar para exibição.

• Canonical

Se por qualquer motivo (um re-post, por exemplo) você desejar alterar a url canônica do seu post, você pode utilizar o metadado canonicalHref apontando para a url original. Veja o exemplo abaixo:

---
createdAt: 2019-05-12
...
canonicalHref: 'https://meublog.com.br/post-original'
---

Desenvolvimento do website local

Requisitos: Docker e Docker-compose instalados localmente;

Passos:

• Fazer fork do repositório;
• Inicializar o container;
• Abrir a URL http://localhost:3000/ e ver o site rodando :)
• Após fazer suas alterações, enviar um PR para master com as alterações;

Inicialização do Container:

Básico

• Utilizar o helper para construir, instalar e rodar o ambiente local:

make install

• Para encerrar:

make stop

Uma vez que o ambiente é construído, nas proximas vezes bastar rodar o comando para inicializar

make start

Para mais comandos utilize o help:

make help

Avançado

• Fazer o build do container do docker:

docker-compose build

• Rodar composer install:

docker-compose run --rm web composer install

• Rodar yarn install:

docker-compose run --rm web yarn install

• Deixar o yarn "observando" as mudanças (e gerando o conteúdo estático):

docker-compose up