Skip to content

Add documentation website with Vite, TypeScript, TailwindCSS, and shadcn/ui#63

Merged
LittleLittleCloud merged 5 commits intomainfrom
copilot/create-document-website
Oct 27, 2025
Merged

Add documentation website with Vite, TypeScript, TailwindCSS, and shadcn/ui#63
LittleLittleCloud merged 5 commits intomainfrom
copilot/create-document-website

Conversation

Copy link
Contributor

Copilot AI commented Oct 25, 2025

Implements a static documentation site for RazorConsole to provide structured component reference and onboarding materials.

Structure

  • Home (/) - Feature overview, inline quick start, links to examples
  • Quick Start (/quick-start) - Installation, project setup, first component
  • Components (/components) - Interactive reference for all 17 built-in components with category filtering (Layout, Input, Display, Utilities), code examples, and parameter tables
  • Advanced (/advanced) - Hot Reload, Custom Translators, Keyboard Events, Focus Management

Stack

  • Vite + React + TypeScript
  • TailwindCSS with dark mode
  • shadcn/ui (Button, Card, Tabs)
  • React Router for client-side routing

Component Documentation Format

Each component includes:

  • Description and category badge
  • Tabbed interface: Examples | Parameters
  • Syntax-highlighted code snippets
  • Parameter reference table (type, default, description)

Example for TextButton:

<TextButton 
  Content="Click me"
  OnClick="HandleClick"
  BackgroundColor="Color.Grey"
  FocusedColor="Color.Blue" 
/>

Structure

website/
├── src/
│   ├── components/
│   │   ├── ui/          # shadcn components
│   │   └── Layout.tsx   # Header, nav, footer
│   ├── pages/           # Route pages
│   ├── data/
│   │   └── components.ts  # Component metadata
│   └── lib/utils.ts
├── vite.config.ts       # Path aliases (@/*)
└── tailwind.config.js

Screenshots

Home Page
Home

Components Page
Components

Usage

cd website
npm install
npm run dev     # http://localhost:5173
npm run build   # → dist/
Original prompt

This section details on the original issue you should resolve

<issue_title>website</issue_title>
<issue_description>Create a document website

  • use vite/typescript/tailwindcss/shadcn
  • should contain a main page and a component page
  • the main page should contain instructions on quick start/advanced topic
  • the component page should contain a list of built-in components plus sample code and previews</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…dcn/ui

Co-authored-by: LittleLittleCloud <16876986+LittleLittleCloud@users.noreply.github.com>
Copilot AI changed the title [WIP] Create document website with main and component pages Add documentation website with Vite, TypeScript, TailwindCSS, and shadcn/ui Oct 25, 2025
@LittleLittleCloud LittleLittleCloud marked this pull request as ready for review October 26, 2025 01:00
…board events, and hot reload support

- Introduced new markdown files for:
  - Custom Translators
  - Focus Management
  - Keyboard Events
  - Hot Reload Support
- Updated Advanced page to display new documentation sections using ReactMarkdown.
- Added Tailwind CSS support in the project.
- Included new dependencies: react-markdown, remark-gfm, and @tailwindcss/vite.
- Configured Vite to use Tailwind CSS and added type definitions for markdown imports.
- Added `react-syntax-highlighter` and its types for code highlighting.
- Introduced `CopyButton` component for copying code snippets to clipboard.
- Created `MarkdownRenderer` component for rendering Markdown content with syntax highlighting.
- Implemented `Docs` page to display documentation topics with navigation.
- Updated `Home` page to link to documentation and display quick start snippets.
- Created `built-in-components.md` and `quick-start.md` for detailed documentation.
- Refactored `Advanced` and `QuickStart` pages to redirect to the new Docs page.
- Updated navigation links in `Layout` component to reflect new documentation structure.
@LittleLittleCloud LittleLittleCloud merged commit c4362c8 into main Oct 27, 2025
5 checks passed
@LittleLittleCloud LittleLittleCloud deleted the copilot/create-document-website branch October 27, 2025 11:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

website

3 participants