Move docs to docs directory in site

This commit is contained in:
Diego Marcos Segura
2025-05-31 00:09:40 -07:00
parent 7dc6e0e9e3
commit 8cba08aabb
16 changed files with 23 additions and 22 deletions
@@ -9,8 +9,8 @@ Copy and paste code below in an `index.html` file or remix in the [Web Playgroun
<script type="importmap">
{
"imports": {
"three": "/node_modules/three/build/three.module.js",
"@worldlabsai/forge": "/dist/forge.module.js"
"three": "https://cdnjs.cloudflare.com/ajax/libs/three.js/0.174.0/three.module.js",
"@worldlabsai/forge": "https://forge.dev/releases/forge/0.1.0/forge.module.js"
}
}
</script>
@@ -19,14 +19,15 @@ import * as THREE from "three";
import { SplatMesh } from "@worldlabsai/forge";
const scene = new THREE.Scene();
const camera = new THREE.PerspectiveCamera(75, window.innerWidth / window.innerHeight, 0.1, 1000);
const camera = new THREE.PerspectiveCamera(60, window.innerWidth / window.innerHeight, 0.1, 1000);
const renderer = new THREE.WebGLRenderer();
renderer.setSize(window.innerWidth, window.innerHeight);
document.body.appendChild(renderer.domElement)
`
const butterfly = new SplatMesh({ url: "../assets/splats/butterfly.spz"});
const splatURL = "https://forge.dev/assets/splats/butterfly.spz";
const butterfly = new SplatMesh({ url: splatURL });
butterfly.quaternion.set(1, 0, 0, 0);
butterfly.position.set(0, 0, -1);
butterfly.position.set(0, 0, -3);
scene.add(butterfly);
renderer.setAnimationLoop(function animate(time) {
@@ -38,7 +39,7 @@ renderer.setAnimationLoop(function animate(time) {
## Install with NPM
```shell
npm install forge-dev
npm install @forge-gfx/forge
```
## Develop and contribute to Forge
+1 -1
View File
@@ -8,6 +8,6 @@ hide:
<div class="hero">
<h1><img src="/assets/images/logo-hero.png"/></h1>
<h2>An advanced 3D Gaussian Splatting renderer for THREE.js</h2>
<a href="/getting-started/" class="md-button md-button--primary">Get started →</a>
<a href="/docs/" class="md-button md-button--primary">Get started →</a>
<img class="hero-image" src="/assets/images/hero-image.png"/>
</div>
+1 -1
View File
@@ -16,7 +16,7 @@
<!-- Right: Custom links + search -->
<div class="md-custom-header-right">
<a href="/examples/" class="md-nav__link">Examples</a>
<a href="/getting-started/" class="md-nav__link">Docs</a>
<a href="/docs/" class="md-nav__link">Docs</a>
<a href="/viewer/" class="md-nav__link">Viewer</a>
<a rel="noopener noreferrer" class="contrast" aria-label="Discord channel" href="https://discord.gg/W39qmSKemS" target="_blank">
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="icon-discord" viewBox="0 -2 16 16">
+13 -13
View File
@@ -9,19 +9,19 @@ extra_css:
- stylesheets/forge.css
nav:
- Home: index.md
- Getting Started: getting-started.md
- Overview: overview.md
- System Design: system-design.md
- ForgeRenderer: forge-renderer.md
- ForgeViewpoint: forge-viewpoint.md
- SplatMesh: splat-mesh.md
- PackedSplats: packed-splats.md
- Loading Gsplats: loading-splats.md
- Procedural Splats: procedural-splats.md
- Splat RGBA-XYZ SDF editing: splat-editing.md
- Controls: controls.md
- Performance tuning: performance.md
- Community Resources: community-resources.md
- Getting Started: docs/index.md
- Overview: docs/overview.md
- System Design: docs/system-design.md
- ForgeRenderer: docs/forge-renderer.md
- ForgeViewpoint: docs/forge-viewpoint.md
- SplatMesh: docs/splat-mesh.md
- PackedSplats: docs/packed-splats.md
- Loading Gsplats: docs/loading-splats.md
- Procedural Splats: docs/procedural-splats.md
- Splat RGBA-XYZ SDF editing: docs/splat-editing.md
- Controls: docs/controls.md
- Performance tuning: docs/performance.md
- Community Resources: docs/community-resources.md
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true