Website
The Collab Server hosts the public Quiet Frames website with documentation and news.
Structure
/ → Landing Page
/docs → Documentation
/docs/:category → Category overview
/docs/:category/:page → Individual doc page
/news → News list
/news/:slug → News articleContent Directory
content/
├── docs/
│ ├── README.md # Docs homepage
│ ├── cc-toolbox/ # cc-toolbox Docs
│ │ ├── 001-overview.md
│ │ ├── 002-core.md
│ │ └── ...
│ ├── artworks-studio/ # Studio Docs
│ │ ├── 001-introduction.md
│ │ └── ...
│ └── collab-server/ # Server Docs
│ ├── 001-introduction.md
│ └── ...
├── news/
│ ├── 2024-01-15-release-1.0.md
│ └── 2024-02-20-new-features.md
└── pages/
├── about.md
└── contact.mdDocumentation
Markdown Features
- Syntax Highlighting for code blocks
- Mermaid Diagrams for flowcharts
- Tables with GitHub syntax
- Frontmatter for metadata
Frontmatter
---
title: Overview
description: Introduction to cc-toolbox
order: 1
---
# Overview
Content here...Code Blocks
```typescript
import { Artwork } from '@carstennichte/cc-toolbox';
```Sorting
Docs are sorted by filename:
001-introduction.md → First
002-core.md → Second
003-catalog.md → ThirdNews / Blog
File Format
YYYY-MM-DD-slug.mdExample: 2024-06-15-version-2-released.md
Frontmatter
---
title: Version 2.0 Released
date: 2024-06-15
author: Carsten Nichte
tags: [release, features]
image: /assets/news/v2-header.jpg
---
We are excited to announce Version 2.0...Templates
The website uses Handlebars templates:
templates/
├── layouts/
│ └── main.html # Main layout
├── partials/
│ ├── header.html # Navigation
│ ├── footer.html # Footer
│ └── sidebar.html # Docs Sidebar
├── landing.html # Homepage
├── docs-index.html # Docs overview
├── docs-page.html # Doc page
├── news-list.html # News list
└── news-article.html # News articleStyling
CSS is inline in the templates:
:root {
--bg-primary: #0d0d0d;
--bg-card: #1a1a1a;
--text-primary: #e5e5e5;
--accent: #3b82f6;
}Assets
Static files in content/assets/:
assets/
├── images/
│ ├── logo.svg
│ └── hero.jpg
├── fonts/
└── downloads/Access via /assets/images/logo.svg.
Caching
| Type | Cache Duration |
|---|---|
| HTML | No Cache (Dev) |
| CSS/JS | 1 Day |
| Images | 7 Days |
| Fonts | 30 Days |