Browse Source

fix(docs): minor corrections on shapes docs

alvarosabu 2 years ago
parent
commit
aecc54fa23

+ 8 - 9
docs/cientos/shapes/box.md

@@ -6,16 +6,16 @@ The `cientos` package provides a `<Box />` component that serves as a short-cut
 
 
 ```typescript
 ```typescript
 args: [
 args: [
-        width: number,
-        height: number,
-        depth: number,
-        widthSegments: number,
-        heightSegments: number,
-        depthSegments: number
-      ]
+  width: number,
+  height: number,
+  depth: number,
+  widthSegments: number,
+  heightSegments: number,
+  depthSegments: number
+]
 ```
 ```
-reference: [BoxGeometry](https://threejs.org/docs/?q=box#api/en/geometries/BoxGeometry)
 
 
+Reference: [BoxGeometry](https://threejs.org/docs/?q=box#api/en/geometries/BoxGeometry)
 
 
 ## Usage
 ## Usage
 
 
@@ -27,4 +27,3 @@ reference: [BoxGeometry](https://threejs.org/docs/?q=box#api/en/geometries/BoxGe
   <TresMeshToonMaterial color="orange" />
   <TresMeshToonMaterial color="orange" />
 </Box>
 </Box>
 ```
 ```
-

+ 1 - 3
docs/cientos/shapes/circle.md

@@ -7,8 +7,8 @@ The `cientos` package provides a `<Circle />` component that serves as a short-c
 ```typescript
 ```typescript
 args: [radius: number, segments: number, thetaStart: number, thetaLength: number]
 args: [radius: number, segments: number, thetaStart: number, thetaLength: number]
 ```
 ```
-reference: [CircleGeometry](https://threejs.org/docs/?q=circle#api/en/geometries/CircleGeometry)
 
 
+Reference: [CircleGeometry](https://threejs.org/docs/?q=circle#api/en/geometries/CircleGeometry)
 
 
 ## Usage
 ## Usage
 
 
@@ -20,5 +20,3 @@ reference: [CircleGeometry](https://threejs.org/docs/?q=circle#api/en/geometries
   <TresMeshToonMaterial color="lightsalmon" />
   <TresMeshToonMaterial color="lightsalmon" />
 </Circle>
 </Circle>
 ```
 ```
-
-

+ 9 - 9
docs/cientos/shapes/cone.md

@@ -6,17 +6,17 @@ The `cientos` package provides a `<Cone />` component that serves as a short-cut
 
 
 ```typescript
 ```typescript
 args: [
 args: [
-         radius: number,
-         height: number,
-         radialSegments: number,
-         heightSegments: number,
-         openEnded: boolean,
-         thetaStart: number,
-         thetaLength: number
-       ]
+  radius: number,
+  height: number,
+  radialSegments: number,
+  heightSegments: number,
+  openEnded: boolean,
+  thetaStart: number,
+  thetaLength: number
+]
 ```
 ```
-reference: [ConeGeometry](https://threejs.org/docs/?q=cone#api/en/geometries/ConeGeometry)
 
 
+Reference: [ConeGeometry](https://threejs.org/docs/?q=cone#api/en/geometries/ConeGeometry)
 
 
 ## Usage
 ## Usage
 
 

+ 1 - 2
docs/cientos/shapes/dodecahedron.md

@@ -7,8 +7,8 @@ The `cientos` package provides a `<Dodecahedron />` component that serves as a s
 ```typescript
 ```typescript
 args: [radius: number, detail: number]
 args: [radius: number, detail: number]
 ```
 ```
-reference: [DodecahedronGeometry](https://threejs.org/docs/?q=dode#api/en/geometries/DodecahedronGeometry)
 
 
+Reference: [DodecahedronGeometry](https://threejs.org/docs/?q=dode#api/en/geometries/DodecahedronGeometry)
 
 
 ## Usage
 ## Usage
 
 
@@ -20,4 +20,3 @@ reference: [DodecahedronGeometry](https://threejs.org/docs/?q=dode#api/en/geomet
   <TresMeshToonMaterial color="deeppink" />
   <TresMeshToonMaterial color="deeppink" />
 </Dodecahedron>
 </Dodecahedron>
 ```
 ```
-

+ 2 - 1
docs/cientos/shapes/icosahedron.md

@@ -7,7 +7,8 @@ The `cientos` package provides a `<Icosahedron />` component that serves as a sh
 ```typescript
 ```typescript
 args: [radius: number, detail: number]
 args: [radius: number, detail: number]
 ```
 ```
-reference: [IcosahedronGeometry](https://threejs.org/docs/?q=ico#api/en/geometries/IcosahedronGeometry)
+
+Reference: [IcosahedronGeometry](https://threejs.org/docs/?q=ico#api/en/geometries/IcosahedronGeometry)
 
 
 ## Usage
 ## Usage
 
 

+ 1 - 1
docs/cientos/shapes/octahedron.md

@@ -7,8 +7,8 @@ The `cientos` package provides a `<Octahedron />` component that serves as a sho
 ```typescript
 ```typescript
 args: [radius: number, detail: number]
 args: [radius: number, detail: number]
 ```
 ```
-reference: [OctahedronGeometry](https://threejs.org/docs/?q=octa#api/en/geometries/OctahedronGeometry)
 
 
+Reference: [OctahedronGeometry](https://threejs.org/docs/?q=octa#api/en/geometries/OctahedronGeometry)
 
 
 ## Usage
 ## Usage
 
 

+ 2 - 1
docs/cientos/shapes/plane.md

@@ -7,7 +7,8 @@ The `cientos` package provides a `<Plane />` component that serves as a short-cu
 ```typescript
 ```typescript
 args: [width: number, height: number, widthSegments: number, heightSegments: number]
 args: [width: number, height: number, widthSegments: number, heightSegments: number]
 ```
 ```
-reference: [PlaneGeometry](https://threejs.org/docs/?q=plane#api/en/geometries/PlaneGeometry)
+
+Reference: [PlaneGeometry](https://threejs.org/docs/?q=plane#api/en/geometries/PlaneGeometry)
 
 
 ::: info
 ::: info
 A convenient default rotation is applied to the _x-axis_ of the plane (`-Math.PI / 2`), so that it is facing up (along the Y axis).
 A convenient default rotation is applied to the _x-axis_ of the plane (`-Math.PI / 2`), so that it is facing up (along the Y axis).

+ 8 - 10
docs/cientos/shapes/ring.md

@@ -6,16 +6,16 @@ The `cientos` package provides a `<Ring />` component that serves as a short-cut
 
 
 ```typescript
 ```typescript
 args: [
 args: [
-         innerRadius: number,
-         outerRadius: number,
-         thetaSegments: number,
-         phiSegments: number,
-         thetaStart: number,
-         thetaLength: number
-      ]
+  innerRadius: number,
+  outerRadius: number,
+  thetaSegments: number,
+  phiSegments: number,
+  thetaStart: number,
+  thetaLength: number
+]
 ```
 ```
-reference: [RingGeometry](https://threejs.org/docs/?q=ring#api/en/geometries/RingGeometry)
 
 
+Reference: [RingGeometry](https://threejs.org/docs/?q=ring#api/en/geometries/RingGeometry)
 
 
 ## Usage
 ## Usage
 
 
@@ -27,5 +27,3 @@ reference: [RingGeometry](https://threejs.org/docs/?q=ring#api/en/geometries/Rin
   <TresMeshToonMaterial color="purple" />
   <TresMeshToonMaterial color="purple" />
 </Ring>
 </Ring>
 ```
 ```
-
-

+ 9 - 11
docs/cientos/shapes/sphere.md

@@ -6,17 +6,17 @@ The `cientos` package provides a `<Sphere />` component that serves as a short-c
 
 
 ```typescript
 ```typescript
 args: [
 args: [
-         radius: number,
-         widthSegments: number,
-         heightSegments: number,
-         phiStart: number,
-         phiLength: number,
-         thetaStart: number,
-         thetaLength: number
-      ]
+  radius: number,
+  widthSegments: number,
+  heightSegments: number,
+  phiStart: number,
+  phiLength: number,
+  thetaStart: number,
+  thetaLength: number
+]
 ```
 ```
-reference: [SphereGeometry](https://threejs.org/docs/?q=sphere#api/en/geometries/SphereGeometry)
 
 
+Reference: [SphereGeometry](https://threejs.org/docs/?q=sphere#api/en/geometries/SphereGeometry)
 
 
 ## Usage
 ## Usage
 
 
@@ -28,5 +28,3 @@ reference: [SphereGeometry](https://threejs.org/docs/?q=sphere#api/en/geometries
   <TresMeshToonMaterial color="pink" />
   <TresMeshToonMaterial color="pink" />
 </Sphere>
 </Sphere>
 ```
 ```
-
-

+ 1 - 3
docs/cientos/shapes/tetrahedron.md

@@ -7,8 +7,8 @@ The `cientos` package provides a `<Tetrahedron />` component that serves as a sh
 ```typescript
 ```typescript
 args: [radius: number, detail: number]
 args: [radius: number, detail: number]
 ```
 ```
-reference: [TetrahedronGeometry](https://threejs.org/docs/?q=tetr#api/en/geometries/TetrahedronGeometry)
 
 
+Reference: [TetrahedronGeometry](https://threejs.org/docs/?q=tetr#api/en/geometries/TetrahedronGeometry)
 
 
 ## Usage
 ## Usage
 
 
@@ -20,5 +20,3 @@ reference: [TetrahedronGeometry](https://threejs.org/docs/?q=tetr#api/en/geometr
   <TresMeshToonMaterial color="yellow" />
   <TresMeshToonMaterial color="yellow" />
 </Tetrahedron>
 </Tetrahedron>
 ```
 ```
-
-

+ 9 - 11
docs/cientos/shapes/torus-knot.md

@@ -6,16 +6,16 @@ The `cientos` package provides a `<TorusKnot />` component that serves as a shor
 
 
 ```typescript
 ```typescript
 args: [
 args: [
-         radius: number,
-         tube: number,
-         tubularSegments: number,
-         radialSegments: number,
-         p: number,
-         q: number
-      ]
+  radius: number,
+  tube: number,
+  tubularSegments: number,
+  radialSegments: number,
+  p: number,
+  q: number
+]
 ```
 ```
-reference: [TorusKnotGeometry](https://threejs.org/docs/?q=torus#api/en/geometries/TorusKnotGeometry)
 
 
+Reference: [TorusKnotGeometry](https://threejs.org/docs/?q=torus#api/en/geometries/TorusKnotGeometry)
 
 
 ## Usage
 ## Usage
 
 
@@ -24,8 +24,6 @@ reference: [TorusKnotGeometry](https://threejs.org/docs/?q=torus#api/en/geometri
 
 
 // TorusKnot with a custom material transformations
 // TorusKnot with a custom material transformations
 <TorusKnot ref="torusKnotRef" :args="[0.6, 0.2, 64, 8]" :position="[-2, 6, 2]">
 <TorusKnot ref="torusKnotRef" :args="[0.6, 0.2, 64, 8]" :position="[-2, 6, 2]">
-<TresMeshToonMaterial color="lime" />
+  <TresMeshToonMaterial color="lime" />
 </TorusKnot>
 </TorusKnot>
 ```
 ```
-
-

+ 8 - 11
docs/cientos/shapes/torus.md

@@ -6,15 +6,15 @@ The `cientos` package provides a `<Torus />` component that serves as a short-cu
 
 
 ```typescript
 ```typescript
 args: [
 args: [
-         radius: number,
-         tube: number,
-         radialSegments: number,
-         tubularSegments: number,
-         arc: number
-      ]
+  radius: number,
+  tube: number,
+  radialSegments: number,
+  tubularSegments: number,
+  arc: number
+]
 ```
 ```
-reference: [TorusGeometry](https://threejs.org/docs/?q=torus#api/en/geometries/TorusGeometry)
 
 
+Reference: [TorusGeometry](https://threejs.org/docs/?q=torus#api/en/geometries/TorusGeometry)
 
 
 ## Usage
 ## Usage
 
 
@@ -24,8 +24,5 @@ reference: [TorusGeometry](https://threejs.org/docs/?q=torus#api/en/geometries/T
 // Torus with a custom material transformations
 // Torus with a custom material transformations
 <Torus ref="torusRef" :args="[0.75, 0.4, 16, 80]" :position="[-2, 6, 0]">
 <Torus ref="torusRef" :args="[0.75, 0.4, 16, 80]" :position="[-2, 6, 0]">
   <TresMeshToonMaterial color="cyan" />
   <TresMeshToonMaterial color="cyan" />
- </Torus>
-
+</Torus>
 ```
 ```
-
-

+ 7 - 9
docs/cientos/shapes/tube.md

@@ -27,16 +27,15 @@ export default {
 type CurveType = QuadraticBezierCurve3 | CubicBezierCurve3 | CatmullRomCurve3 | LineCurve3
 type CurveType = QuadraticBezierCurve3 | CubicBezierCurve3 | CatmullRomCurve3 | LineCurve3
 
 
 args: [
 args: [
-         path: CurveType,
-         tubularSegments: number,
-         radius: number,
-         radialSegments: number,
-         closed: boolean
-      ]
+  path: CurveType,
+  tubularSegments: number,
+  radius: number,
+  radialSegments: number,
+  closed: boolean
+]
 ```
 ```
 
 
-reference: [TubeGeometry](https://threejs.org/docs/?q=tube#api/en/geometries/TubeGeometry)
-
+Reference: [TubeGeometry](https://threejs.org/docs/?q=tube#api/en/geometries/TubeGeometry)
 
 
 ## Usage
 ## Usage
 
 
@@ -49,4 +48,3 @@ reference: [TubeGeometry](https://threejs.org/docs/?q=tube#api/en/geometries/Tub
   <TresMeshToonMaterial color="lightblue" />
   <TresMeshToonMaterial color="lightblue" />
 </Tube>
 </Tube>
 ```
 ```
-