Este reposítório contém a documentação técnica para usuário da plataforma Glass Data. A documentação está hospedada no endereço https://glassdata.readme.io.
O Readme.io é um serviço de publicação de documentações técnicas que utilizamos. Este repositório é conectado via GitHub e é sincronizado automaticamente, em ambas as direções.
Apesar da extensão .md, os arquivos estão no formato MDX, renderizados internamente pelo pacote readmeio/markdown.
Este projeto está configurado para usar versões fixas de Node.js e rdme:
- Node.js: 25.7.0
- npm: 11.10.1
- rdme: 10.6.2
Arquivos de pinagem:
- .nvmrc
- .node-version
- package.json (engines, packageManager e devDependencies)
- package-lock.json
Passo a passo:
- Instale o Node 25.7.0 com nvm (uma vez): nvm install 25.7.0
- Entre no projeto e carregue a versao fixada: nvm use
- Instale dependencias: npm install
- Confira versoes: node -v npm run rdme:version
Validacao sem publicar (dry-run):
- Referencia: npm run rdme:reference:dry-run
- Guias (docs): npm run rdme:docs:dry-run
Observacao: os comandos de dry-run exigem a variavel de ambiente README_API_KEY.
Exemplo: export README_API_KEY="<sua_chave_do_readme>"