|
1 | | -offscale.io |
2 | | -=========== |
3 | | -[](https://opensource.org/licenses/Apache-2.0) |
4 | | -[](https://github.com/offscale/offscale-www/actions/workflows/main.yml) |
| 1 | +# Offscale.github.io |
5 | 2 |
|
6 | | -Branding, contact, and information SPA. |
| 3 | +This repository hosts the source code for the **Offscale** landing page: [offscale.github.io](https://offscale.github.io). |
| 4 | + |
| 5 | +Offscale provides modern, rapid application tools, bringing "new compilers to 'solve' software." |
| 6 | + |
| 7 | +## π Site Structure |
| 8 | + |
| 9 | +The site is currently organized into two main sections: |
| 10 | + |
| 11 | +### 1. SDKs & Interactive Docs (`index.html`) |
| 12 | +The main landing page focuses entirely on our OpenAPI generation pipeline: |
| 13 | +- **SDK Generation:** Build typed, idiomatic client libraries natively for 13+ languages directly from OpenAPI specs. |
| 14 | +- **Package Publishing:** Automatically publish those SDKs to registries like PyPI, Crates.io, npm, Maven, RubyGems, CocoaPods, and NuGet. |
| 15 | +- **Interactive API Docs:** Generate hostable, versioned static HTML documentation with interactive sample API calls. |
| 16 | + |
| 17 | +### 2. Ecosystem (`ecosystem.html`) |
| 18 | +The broader Offscale suite and high-performance tools: |
| 19 | +- **OpenAPI β Language Compilers:** 13 new bidirectional compilers for major languages. |
| 20 | +- **Rapid Deployment (`libscript`):** Tools to natively deploy and package stacks for DOS, SunOS, Windows, Linux, and macOS (e.g., `.msi`, `.deb`, `.rpm`). |
| 21 | +- **ML Translation (`onnx9000` & `ml-switcheroo`):** Transpile across the entire stack from PyTorch/TensorFlow to JAX, MLX, C++, WebGPU, and WASM. |
| 22 | +- **#rewriteInC:** Build blazing-fast applications using `c-rest-framework`, `c-orm`, `c-abstract-http`, and `c-fs`. |
| 23 | +- **`c-multiplatform`:** A high-performance, native C alternative to frameworks like Kotlin Multiplatform, Flutter, Xamarin, and React Native. Deploy to Web, iOS, Android, Linux, Windows, Consoles, DOS, watchOS, tvOS, and Raspberry Pi. |
| 24 | + |
| 25 | +## π οΈ Development |
| 26 | + |
| 27 | +This is a static HTML/CSS/JS site hosted directly on GitHub Pages. |
| 28 | + |
| 29 | +### Editing Content |
| 30 | +- Edit `index.html` for the SDKs & Docs landing page. |
| 31 | +- Edit `ecosystem.html` for the wider Ecosystem page. |
| 32 | +- Edit `styles.css` for design, layout, and animation changes. |
| 33 | +- Edit `script.js` for interactivity. |
| 34 | + |
| 35 | +### GitHub Pages Configuration |
| 36 | +- `.nojekyll`: Ensures GitHub Pages serves the static files exactly as they are without running Jekyll processing. |
| 37 | +- `CNAME`: Handles custom domain routing. |
| 38 | + |
| 39 | +### Editing Diagrams (Mermaid) |
| 40 | +The architecture and flowchart diagrams on the site are generated using Mermaid.js. |
| 41 | + |
| 42 | +1. Edit the `.mmd` files (e.g., `deploy.mmd`, `ml.mmd`, `c_multiplatform.mmd`, `sdk_cli_docs.mmd`). |
| 43 | +2. Run the generation script to rebuild the SVGs: |
| 44 | + ```bash |
| 45 | + ./mmd_gen.sh |
| 46 | + ``` |
| 47 | + *(Note: This requires `npx` and `@mermaid-js/mermaid-cli`)* |
| 48 | + |
| 49 | +## π License |
| 50 | +Β© 2026 Offscale. Open source tools for modern developers. |
0 commit comments