🧩 Template Core

Usalo in ogni cartella. È intenzionalmente minimalista, prevedibile e student-friendly.

Core Sections

Questo è dove metti la storia della cartella — il "perché", il "come", il collante concettuale.

Questo è una fetta HTML concettuale — semplice, pulita e completamente compatibile con la tua filosofia "render Markdown from repo".

Questo mantiene la pagina:

• quiet
• intuitive
• search-first
• non-narrative
• non-duplicative

Esattamente il vibe "HipChat meets Google" che hai descritto.

Search Behavior Contract

Questo è il contratto di comportamento per la tua search box — chiaro, prevedibile e facile da implementare.

Questo spec ti dà un sistema di ricerca pulito, prevedibile e substrate-aligned che si sente come i bot HipChat che ricordi — veloce, letterale e utile senza essere invadente.

Folder-Level Structure

Avvolge il README.md della cartella — semplice, tranquillo e GitHub-friendly.

Questo template presume che il tuo renderer di siti statici semplicemente carichi Markdown in un content container. Mantiene l'interfaccia minimalista e coerente con la tua pagina di landing search-first.

Questo mantiene le pagine a livello di cartella pulite, prevedibili e allineate con la tua estetica generale.

Image Rotation Component

Lightweight, no dependencies, works with your minimal HTML philosophy.

Questo script ruota attraverso un piccolo set di immagini (diagrammi RTT, motivi del substrato, ecc.). Puoi inserirlo nella tua pagina di landing o in qualsiasi folder-level index.

Puoi regolare l'intervallo a giornaliero, orario, o solo al refresh.

Search Results Layout

Pulito, leggibile e coerente con la tua pagina di landing search-first.

Questo layout è intenzionalmente semplice in modo da poter collegare il tuo motore di ricerca a scelta (indice locale, Lunr.js, backend personalizzato, ecc.).

Questo ti dà:

• raggruppamento pulito
• snippet leggibili
• etichettatura di fonte chiara
• solo link canonici
• nessun disordine

Perfetto per un substrato di ricerca.

Sitemap Generation

Un breve documento canonico che puoi includere in /docs/meta/ o nella radice del tuo repo.

Presume che mantieni un piccolo JSON per cartella (o inline) che descrive i contenuti. Puoi generare tfSitemap tramite un piccolo script offline, o mantenerlo manualmente per cartella.

Folder-Level Script

Questo script cammina nel tuo repo, trova file Markdown + sottocartelle e emette un sitemap.json per ogni cartella.

• Zero dependencies
• Runs on any CI/CD
• Works on GitHub Actions
• Easy to maintain
• Perfect for a Markdown-first repo

Global Sitemap

Questo è il master sitemap che lega insieme tutti i file sitemap.json a livello di cartella. Dà al tuo motore di ricerca, ai tools di navigazione e ai sistemi esterni una singola spina dorsale canonica.

Search Index Generation

Questo crea un indice ricercabile di tutti i file Markdown attraverso il repo. È lightweight, veloce e perfetto per la tua pagina di landing search-first.

Una lista flat di documenti ricercabili:

• No backend
• No server
• Works entirely client-side
• Perfect for static sites
• Fast enough for thousands of documents

Repository Structure Example

Una mappa strutturale leggibile dall'uomo dell'intero repo — perfetta per /docs/meta/ o onboarding dei contributor.

CI/CD Integration

Puoi collegare CI a npm run build. Questo assicura:

• every push updates sitemaps
• no human maintenance
• no drift
• no broken menus

Start Here Component

Presumi che ogni file Markdown possa dichiarare un semplice blocco front-matter. Puoi quindi:

• caricare starthere.json nel wrapper HTML del /docs/README.md
• renderizzare una lista dinamica Start Here raggruppata per tipo (primer, example, simulation)

Poiché il build pipeline rigenera:

• starthere.json
• sitemap.json
• sitemapindex.json
• searchindex.json

La tua documentazione diventa self-maintaining.

Complete Architecture