Skip to content

Latest commit

 

History

History
100 lines (71 loc) · 4.32 KB

README.md

File metadata and controls

100 lines (71 loc) · 4.32 KB
Raw

pythonclub.com.br

Duvidas sobre este projeto, deixe sua mensagem em Gitter

Blog colaborativo sobre tecnologias que envolvam a linguagem Python

Como Contribuir

  • Faça um fork desse repositório, clicando no botão Fork, na parte superior direita da pagina do Github

  • Clone seu fork:

    git clone --depth 1 --recursive https://github.com/SEU_USUARIO_DO_GITHUB/pythonclub.github.io.git

  • Instale os requirements pip install -r requirements.txt - se você não tiver o pip instalado, instale-o: https://pip.pypa.io/en/latest/installing.html#install-pip

  • Todas as publicações ficam na pasta content, os textos podem ser escritos no formato Markdown ou reStructuredText, fique a vontade para usar o que você sentir mais afinidade, veja alguns exemplos.

  • Após criar ou editar seu artigo faça um pull-request para que ele seja adicionado ao site.

  • Caso tenha dificuldades para escrever Markdown ou reStructuredText, veja esses editores online que auxiliam sua escrita:

Não entendeu nada? Veja o video que explica o processo de fork, clone, push e pull-request : http://pythonclub.com.br/como-fazer-fork-clone-push-pull-request-no-github.html

Sincronizando seu fork

Caso você já tenha feito fork a algum tempo você tem duas opções para garantir que estará trabalhando com as ultimas alterações, que pode ser simplesmente deletar seu fork e fazer um novo ou sincronizar seu fork com o repositório de origem usando as instruções contidas na wiki

Informações Técnicas

O site pythonclub.com.br está sendo hospedado usando o Github Pages.

O Github Pages hospeda arquivos HTML sem qualquer tipo de custo, bastando que exista um repositório chamado seu-usuario.github.io (Perceba que deve ser incluido o .github.io). Os arquivos HTML devem ser incluidos no branch master para que o Github automaticamente publique aqueles arquivos HTML na web no endereço: http://seu-usuario.github.io

Para gerar os arquivos HTML, e visando a facilidade de escrever textos utilizando a linguagem de marcação Markdown e reStructuredText, utilizamos o Pelican, que é um projeto feito em Python.

Como a branch master é usada internamente pelo Github para servir os arquivos HTML, criamos uma branch chamado pelican para armazenar os arquivos de configuração e as publicação em seu "estado-bruto".

Essa branch está definida como padrão para o repositório e você possivelmente não precisará se preocupar com isso.

Visualizando sua publicação antes de enviar

O Pelican conta com algumas facilidades que permitem que você teste o site localmente na medida que você vai escrevendo o texto e antes de enviar para o servidor, inclusive vem com um script para facilitar isso.

Para utilizar o script para iniciar basta executar o comando:

./develop_server.sh start

Então basta visitar o endereço http://localhost:8000/

Para finalizar o servidor use:

./develop_server.sh stop