Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
77 commits
Select commit Hold shift + click to select a range
b64c561
feat(cientos): new docs on nuxt
JaimeTorrealba Oct 19, 2025
92938a2
chore(cientos-docs): rename package from "docs-boilerplate" to "cient…
alvarosabu Oct 20, 2025
30aca27
Merge branch 'main' into cientos-docs
alvarosabu Oct 20, 2025
734a283
📝 Add tweaks to navbar, homepage getting-started pages
JaimeTorrealba Oct 22, 2025
1337005
docs(cientos): migration page on new docs
JaimeTorrealba Oct 28, 2025
dc96faa
📝 Migration of orbit controls
JaimeTorrealba Oct 30, 2025
f1e8851
📝 Add automatic fetch of collections.
JaimeTorrealba Oct 30, 2025
38b4d63
📝 Add transform controls (fixing the demo)
JaimeTorrealba Nov 1, 2025
f2785dc
✨ Keyboard controls
JaimeTorrealba Nov 1, 2025
f4f0d6e
📝 pointer lock controls migration
JaimeTorrealba Nov 2, 2025
e594bfe
📝 Camera controls
JaimeTorrealba Nov 2, 2025
8075fac
📝 Migration Loaders section
JaimeTorrealba Nov 6, 2025
7c3b100
Merge branch 'main' into cientos-docs
alvarosabu Nov 8, 2025
95ec8bb
📝 Add materials section
JaimeTorrealba Nov 10, 2025
847e5dd
📝 Add shapes section
JaimeTorrealba Nov 12, 2025
7da301d
📝New section debug/performance. Includes:
JaimeTorrealba Nov 15, 2025
03ec31a
docs(cientos): add new section light/shadow, with
JaimeTorrealba Nov 16, 2025
bbb9cf7
feat(cientos): Migration staging section
JaimeTorrealba Nov 19, 2025
748bdcb
docs(cientos): migration of abstractions.
JaimeTorrealba Nov 22, 2025
de48cc9
docs(cientos): new section Objects:
JaimeTorrealba Nov 24, 2025
3a4fe63
docs(cientos): last migration miscellaneous section.
JaimeTorrealba Nov 27, 2025
da4ea31
docs(cientos): Implement all* index page.
JaimeTorrealba Dec 1, 2025
95fb631
Merge branch 'main' into cientos-docs
JaimeTorrealba Dec 1, 2025
6d3d3a4
Merge branch 'main' into cientos-docs
JaimeTorrealba Dec 2, 2025
a522415
Merge branch 'main' into cientos-docs
alvarosabu Dec 3, 2025
1399b0f
refactor: update logo and branding in TheLogo component
alvarosabu Dec 3, 2025
4cce85c
chore: update package.json dependencies to use catalog:nuxt and catal…
alvarosabu Dec 3, 2025
d1d71c8
chore: update pnpm-lock.yaml and package.json to use catalog:nuxt for…
alvarosabu Dec 3, 2025
ca84097
docs(cientos): remove duplicated titles on pages
JaimeTorrealba Dec 3, 2025
6eb058f
docs(cientos): demos restored and with Leches pane
JaimeTorrealba Dec 3, 2025
0e24fe1
cientos(docs): add leches to controls demos
JaimeTorrealba Dec 4, 2025
b4129d7
cientos(docs): add leches to debug section and fix demos on loaders s…
JaimeTorrealba Dec 4, 2025
db00bc0
cientos(docs): Leches to Light/Shadow section
JaimeTorrealba Dec 5, 2025
5f1c322
lint
JaimeTorrealba Dec 5, 2025
60edb72
docs(cientos): add Leches to materials section, to note here:
JaimeTorrealba Dec 6, 2025
6393349
cientos(docs): add leches to misc section
JaimeTorrealba Dec 6, 2025
2c3062a
cientos(docs): Leches to all demos in shape section (Some weirdness h…
JaimeTorrealba Dec 7, 2025
63b9683
Merge branch 'main' into cientos-docs
JaimeTorrealba Dec 8, 2025
77c9cc0
docs(cientos): add Leches to object section.
JaimeTorrealba Dec 8, 2025
7b3f5a6
docs(cientos): add leches to staged section
JaimeTorrealba Dec 9, 2025
0774545
lint
JaimeTorrealba Dec 9, 2025
d093eef
docs(cientos): small fixes on precipitation demo & ocean docs
JaimeTorrealba Dec 9, 2025
991c68c
docs(cientos): adding editor config to gitignore
JaimeTorrealba Dec 10, 2025
4f0314f
Merge branch 'main' into cientos-docs
JaimeTorrealba Dec 10, 2025
ad67fd0
lint
JaimeTorrealba Dec 11, 2025
7febb39
update pnpm lock
JaimeTorrealba Dec 11, 2025
cad2997
Merge branch 'main' into cientos-docs
JaimeTorrealba Dec 13, 2025
78a0219
docs(cientos): add camera shake
JaimeTorrealba Dec 13, 2025
dd2099e
docs(cientos): improve new html docs, based on the #1239
JaimeTorrealba Dec 13, 2025
3d0c1c4
Merge branch 'main' into cientos-docs
alvarosabu Dec 15, 2025
09c7811
docs(cientos): fix code review.
JaimeTorrealba Dec 15, 2025
e2bbecb
Merge branch 'main' into cientos-docs
alvarosabu Dec 19, 2025
d9f9f97
docs(cientos): fix missing links
JaimeTorrealba Dec 19, 2025
728dd3d
chore(cientos-docs): add Netlify configuration
alvarosabu Dec 20, 2025
25213d7
replace UAlert -> prose-warnings
JaimeTorrealba Dec 23, 2025
73c26e7
docs(cientos): minor tweaks
alvarosabu Jan 16, 2026
c7daac3
chore: abstract scene wrappers with controls
alvarosabu Jan 16, 2026
9cdfd4a
refactor(loaders): remove unnecessary div wrappers around TresCanvas …
alvarosabu Jan 16, 2026
7f66c2e
chore(cientos-docs): scene wrapper controls for materials and shapes
alvarosabu Jan 16, 2026
e23b80b
chore: controls for debug performance
alvarosabu Jan 16, 2026
066db57
chore: update lighting demos
alvarosabu Jan 16, 2026
e933ced
chore: updated staging components
alvarosabu Jan 16, 2026
158d720
chore: updated objects and misc
alvarosabu Jan 16, 2026
e440d92
Merge branch 'main' into cientos-docs
JaimeTorrealba Jan 16, 2026
12b12d0
docs(cientos): update smoke
JaimeTorrealba Jan 16, 2026
be3fab4
Merge branch 'chore/cientos-docs-scene-wrapper-approach' into cientos…
JaimeTorrealba Jan 16, 2026
39a816a
Merge pull request #1273 from Tresjs/chore/cientos-docs-scene-wrapper…
JaimeTorrealba Jan 16, 2026
193265d
Merge branch 'cientos-docs' of https://github.com/Tresjs/tres into ci…
JaimeTorrealba Jan 16, 2026
37629a1
docs(cientos): add new smoke demo to use uuid on leches
JaimeTorrealba Jan 16, 2026
c526978
docs(cientos): Alvaro second review (lint problem)
JaimeTorrealba Jan 17, 2026
267c74c
Merge branch 'main' into cientos-docs
alvarosabu Jan 19, 2026
bf30f5a
docs(cientos-docs): update installation instructions for create-tres …
alvarosabu Jan 19, 2026
d0dcfc1
chore(cientos-docs): lint formatting
alvarosabu Jan 19, 2026
fcddf20
docs(cientos-docs): fix code formatting in upgrade guide example
alvarosabu Jan 19, 2026
8737750
docs(cientos): Move Grid components from debug/performance to shapes.
JaimeTorrealba Jan 20, 2026
c71dd1a
docs(cientos-docs): update llms configuration for Cientos documentati…
alvarosabu Jan 27, 2026
b1f93a6
Merge branch 'main' into cientos-docs
alvarosabu Jan 27, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 0 additions & 18 deletions apps/cientos-docs-vitepress/guide/abstractions/edges.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,21 +42,3 @@ import { Box, Edges } from '@tresjs/cientos'
| :---------------- | :--------------------------------------------------- | ------------------------- |
| **color** | `THREE.Color` — Color of the edges. <br> More informations : [TresColor](https://docs.tresjs.org/api/instances-arguments-and-props.html#colors) — [THREE.Color](https://threejs.org/docs/#api/en/math/Color) | `#ff0000` |
| **threshold** | `number` — An edge is only rendered if the angle (in degrees) between the face normals of the adjoining faces exceeds this value | `1` |

## Exposed properties

| Event | Description |
| :---------- | :--------------------------------------------------------------- |
| `instance` | Instance reference — Inheritance of [LineSegments](https://threejs.org/docs/#api/en/objects/LineSegments).|

```typescript{1}
const edgesRef = shallowRef(null)

console.log(edgesRef.value.instance) // instance properties
```

```vue{2}
<template>
<Edges ref="edgesRef" />
</template>
```
Binary file modified apps/cientos-docs/.data/content/contents.sqlite
Binary file not shown.
11 changes: 11 additions & 0 deletions apps/cientos-docs/.editorconfig
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JaimeTorrealba, this file should be added to the gitignore. We should consider adding one like this on the root in another PR.

For now, the linting should have the final word.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added, this was on the docs-boilerplate

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# EditorConfig is awesome: https://EditorConfig.org

root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true
24 changes: 24 additions & 0 deletions apps/cientos-docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Nuxt dev/build outputs
.output
.data
.nuxt
.nitro
.cache
dist

# Node dependencies
node_modules

# Logs
logs
*.log

# Misc
.DS_Store
.fleet
.idea

# Local env files
.env
.env.*
!.env.example
1 change: 1 addition & 0 deletions apps/cientos-docs/.npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
shamefully-hoist=true
281 changes: 281 additions & 0 deletions apps/cientos-docs/CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,281 @@
# Cientos docs - CLAUDE.md

This is a documentation app built with Nuxt v4 and Nuxt UI v4. It serves as a reference implementation for creating new documentation sites in the TresJS ecosystem.

## Overview

This docs provides a complete setup for creating documentation sites with:

- Nuxt v4 with compatibility mode enabled
- Nuxt UI v4 for beautiful, accessible components
- Nuxt Content for markdown-based content
- TresJS integration for 3D examples
- Full-text search functionality
- Dark mode support
- SEO optimization

## Architecture

### App Structure

```
app/
├── app.config.ts # UI theme and app configuration
├── app.vue # Root application component
├── error.vue # Error page component
├── assets/css/ # Global styles
├── components/ # Vue components
│ ├── content/ # MDC prose components
│ └── diagrams/ # Custom diagram components
├── composables/ # Composable functions (useNavigation)
├── layouts/ # Page layouts (docs.vue)
├── pages/ # Route pages
│ ├── index.vue # Landing page
│ └── [...slug].vue # Dynamic docs pages
└── utils/ # Utility functions
```

### Content Structure

Content is organized in numbered directories for ordering:

```
content/
├── index.md # Landing page content
├── 1.getting-started/ # Getting started section
├── 2.guide/ # Guide section
└── 3.api/ # API reference section
```

## Key Features

### Nuxt UI v4

- Uses Nuxt UI v4 components (`UApp`, `UPage`, `UMain`, etc.)
- Custom theme configuration in `app.config.ts`
- Teal color scheme as primary
- Custom CSS variables for patterns and gradients

### Nuxt Content

- Markdown with MDC (Markdown Components) syntax
- Collection-based content management
- Automatic table of contents generation
- Search integration

### TresJS Integration

- Vue template compiler options configured for TresJS
- Support for 3D scene components
- Ready for interactive 3D examples

### SEO & Meta

- Configured SEO meta tags
- Open Graph and Twitter card support
- Dynamic titles and descriptions
- Sitemap generation ready

## Configuration

### Theme Customization

Edit `app/app.config.ts` to customize:

```
ui: {
colors: {
primary: 'teal', // Change primary color
neutral: 'zinc' // Change neutral color
},
}
```

### Navigation

Edit `app/composables/useNavigation.ts` to modify header navigation links.

### Content Collections

Content is organized using Nuxt Content collections defined in `content.config.ts`:

- `landing` - Landing page (index.md)
- `docs` - All documentation pages

### LLM Documentation

The `nuxt-llms` module is configured to generate LLM-friendly documentation at `/llms.txt` and `/llms-full.txt`.

## Components

### Layout Components

- **AppHeader** - Site header with navigation, search, and color mode toggle
- **AppFooter** - Footer with links and copyright
- **AppSide** - Sidebar navigation for docs layout

### Content Components

- **ProseA** - Enhanced anchor links in markdown content

### Diagram Components

Custom SVG diagram components for technical documentation.

## Development

### Prerequisites

- Node.js 18+
- pnpm package manager

### Commands

```bash
# Install dependencies
pnpm install

# Development server
pnpm dev

# Build for production
pnpm build

# Preview production build
pnpm preview

# Lint code
pnpm lint

# Type checking
pnpm typecheck
```

## Styling

### CSS Architecture

- **Tailwind CSS v4** via `@import 'tailwindcss'`
- **Nuxt UI** styles via `@import '@nuxt/ui'`
- Custom theme variables in `main.css`
- Pattern backgrounds (`.pattern-bg`, `.pattern-dot-bg`)

### Color Palette

Two custom color palettes are defined:

- **Teal** (50-950) - Primary brand color
- **Yellow/Brown** (50-950) - Accent color

### Dark Mode

Automatic dark mode with theme-aware pattern backgrounds and custom favicon switching.

## Content Writing

### Markdown Format

```md
---
title: Page Title
description: Page description for SEO
---

# Heading

Content here with **bold** and *italic* text.

::callout
Custom MDC component
::
```

### MDC Components

Use Vue components directly in markdown:

```md
::block-hero
---
cta:
- Get started
- /getting-started
---

#title
Hero Title

#description
Hero description
::
```

## Deployment

### Static Site Generation

Configured for static site generation with Nitro prerendering:

```
nitro: {
prerender: {
routes: ['/'],
crawlLinks: true,
},
}
```

### Environment Variables

Create `.env` file for environment-specific configuration (use `.env.example` as reference).

## Best Practices

1. **Content Organization** - Use numbered prefixes for ordering
2. **Component Naming** - Use PascalCase for components
3. **MDC Syntax** - Leverage MDC for rich content
4. **Accessibility** - All UI components are accessible by default
5. **Performance** - Images are optimized via @nuxt/image
6. **SEO** - Always include title and description frontmatter

## Extending the Boilerplate

### Adding New Sections

1. Create new directory in `content/`
2. Add index page with navigation
3. Update `useNavigation.ts` if needed
4. Update `llms` configuration in `nuxt.config.ts`

### Custom Components

1. Add components in `app/components/`
2. MDC components go in `app/components/content/`
3. Auto-imported by Nuxt

### Styling Customization

1. Update theme variables in `app.config.ts`
2. Add custom CSS in `app/assets/css/main.css`
3. Use Tailwind utilities for component styles

## Troubleshooting

### Build Issues

- Ensure Node.js 18+ is installed
- Clear `.nuxt` and `node_modules`, reinstall
- Check `pnpm-workspace.yaml` includes `apps/*`

### Content Not Rendering

- Check frontmatter syntax
- Verify collection configuration in `content.config.ts`
- Ensure files use `.md` extension

## Resources

- [Nuxt Documentation](https://nuxt.com)
- [Nuxt UI Documentation](https://ui.nuxt.com)
- [Nuxt Content Documentation](https://content.nuxt.com)
- [TresJS Documentation](https://docs.tresjs.org)
Loading
Loading