Skip to content

wpbrasil/odin-expo

Repository files navigation

Odin Expo

Odin Expo é um showcase de sites desenvolvidos com Odin, criado pela comunidade WordPress Brasil.

Inspirado em Bootstrap Expo, Built With Ember e Beautiful Open. Este site é feito como Jekyll, desenvolvido no GitHub, e é hospedado no GitHub Pages.

Como enviar um site

Para enviar uma sugestão de site, abra uma issue ou crie um pull request. Será dada prioridade para as sugestões que seguirem as regras.

Verifique se já não existe um Issue ou Pull Request com o mesmo site. Apenas um site por Issue ou Pull Request.

1) Execute o site localmente (Opcional)

Esta é uma etapa opcional caso queira pré-visualizar o resultado da sua publicação ou fazer outras alterações mais profundas.

Opção 1 - Jekyll com Docker

Instale o Docker.

docker-compose up

Opção 2 - Jekyll com Ruby / Bundler

Instale Ruby, Bundler com gem install bundler, e execute run bundle install. Isso irá instalar as dependências Ruby, como o Jekyll e seus plugins. Usuários Windows: Leia este guia para rodar Jekyll no Windows sem problemas.

bundle exec jekyll serve

2) Crie uma nova publicação

Dentro do diretório _site, crie um novo arquivo no formato .md seguindo o formato:

---
layout: post
title: "Título do site"
slug: slug-do-site
source: http://url-do-site.com.br
screenshot: image-do-site.png
---

3) Capturar screenshot

A imagem deverá ser salva otimizada em screenshots/ com dimensões corretas, 1000x800px.

Antes de enviar, é uma boa pratica otimizar a imagem através de um otimizador como o TinyPNG ou ImageOptim. Isso ajudará a manter o site rápido e o repositório mais leve possível.

Dica: Use os pacotes Node, pageres-cli e imagemin-cli, para gerar e otimizar o screenshot no formato .png do site através do url, siga o exemplo a abaixo. Lembre-se de substituir wordpress.org pelo url do seu site.

Licença

MIT © odin-expo

Releases

No releases published

Packages

No packages published