Site estático da documentação da API do Atende Simples, desenvolvido com Slate. Para acessar a documentação online, veja http://atendesimples.github.io/api-docs.

Para acessar a documentação offline, instale o Ruby 2.2.2 e siga as seguintes instruções:

1. Baixe o código-fonte do site:

git clone https://github.com/atendesimples/api-docs.git

1. Instale as gems:

cd api-docs
bundle install

1. Inicie o servidor web de teste:

bundle exec middleman server

1. Acesse a documentação no seu browser via http://localhost:4567/

• /
• /general
• /algar

Para compilar os arquivos e gerar as páginas estáticas + assets, execute o comando:

rake build

Os arquivos estáticos serão gerados em $[DIRETÓRIO_DO_PROJETO]/build.

Este projeto tem como dependência o middleman-gh-pages, que disponibiliza comandos para facilitar a publicação para o GitHub Pages. Mas antes de começar, você deve ativar o automatic generator nas configurações do projeto. O comando seguinte compila o projeto e publica no GitHub Pages:

rake publish

Para mais informações, consultar a documentação do Slate e do middleman-gh-pages.