# Como Contribuir

Este Knowledge Base é hospedado pelo GitHub Pages, usa o VuePress para gerar as páginas a partir dos tutoriais escritos em Markdown, o Trevis CI faz o deploy na branch gh-pages a partir da master e o Open KB pode ser acessado pelo link grupotesseract.github.io/vuepress-tesseract.

# Instalação Local

git clone https://github.com/grupotesseract/vuepress-tesseract.git
cd vuepress-tesseract

npm install

npm run docs:dev

Acesse localhost:8080/vuepress-tesseract/

# Como criar um tutorial

1. Crie uma pasta com o nome do seu tutorial, sem caracteres especiais e com hífen no lugar do espaço.

mkdir docs/nome-do-tutorial

2. Escreva o texto em markdown, salve o arquivo com o nome README.md

echo '# Nome do Tutorial' > docs/nome-do-tutorial/README.md

3. Faça um commit na master.

git add .
git commit -m 'Nome do Tutorial'
git push origin master

O Trevis CI fara o deploy automático e a página ficara disponível no endereço grupotesseract.github.io/vuepress-tesseract/nome-do-tutorial dentro de alguns minutos.

# Requerir uma revisão

Se o tutorial necessita de uma revisão, abra uma pull request no GitHub.