Private. Intelligent. Yours.
This repository contains the official documentation for NEAR AI Cloud, a platform offering developers access to secure, private, verifiable AI models through a unified API.
Before you begin, ensure you have the following installed:
- Node.js >= 20.0.0 (Download)
- npm (comes with Node.js)
# Clone the repository
git clone https://github.com/nearai/docs.git
cd docs
# Install dependencies
npm install# Start the development server
npm startThis command fetches the latest model data and starts a local development server at http://localhost:3000. Most changes are reflected live without restarting the server.
# Generate static site
npm run buildThis command generates static content into the build directory, ready to be served by any static hosting service.
# Serve the production build
npm run serveTest the production build locally before deploying.
| Command | Description |
|---|---|
npm start |
Start development server with hot reload |
npm run build |
Build production-ready static site |
npm run serve |
Serve the production build locally |
npm run clear |
Clear Docusaurus cache |
npm run fetch-models |
Fetch latest model data from API |
We welcome contributions to improve our documentation! Here's how you can help:
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-improvement) - Make your changes and test locally (
npm start) - Build to verify (
npm run build) - Commit your changes (
git commit -m 'Add amazing improvement') - Push to the branch (
git push origin feature/amazing-improvement) - Open a Pull Request
- Use clear, concise language
- Include code examples where applicable
- Follow the existing documentation structure
- Test all code snippets before submitting
- Use proper markdown formatting
- Markdown Files: Use
.mdxextension for MDX support - Code Blocks: Include language identifiers for syntax highlighting
- Links: Use absolute paths for internal links (e.g.,
/cloud/quickstart) - Images: Store in
static/img/and reference with absolute paths - Components: Create reusable React components in
src/components/
Found a bug or have a feature request? Please open an issue with:
- Clear title and description
- Steps to reproduce (for bugs)
- Expected vs actual behavior
- Screenshots (if applicable)
- Documentation: https://docs.near.ai
- NEAR AI Cloud: https://cloud.near.ai
- GitHub: https://github.com/nearai/docs
- Issues: https://github.com/nearai/docs/issues
Need help? Reach out through:
This project is licensed under the MIT License - see the LICENSE file for details.