Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 2.37 KB

CLAUDE.md

File metadata and controls

53 lines (38 loc) · 2.37 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

This repository contains a comprehensive, standalone HTML guide for Claude Code best practices. It serves as an interactive reference for developers learning to use Claude Code effectively.

File Structure

  • claude-code-guide-standalone.html - Main guide file containing all content, styling, and interactive features in a single HTML document

Key Features

  • Interactive Navigation: Multi-section guide with tabbed navigation
  • Self-Contained: All CSS, JavaScript, and content in one file for easy sharing and offline use
  • Progressive Enhancement: Works without JavaScript, enhanced with interactive features
  • Responsive Design: Optimized for both desktop and mobile viewing
  • Print-Friendly: Includes print styles for physical documentation

Code Architecture

The HTML guide uses:

  • Vanilla JavaScript: No dependencies, simple DOM manipulation for section switching
  • CSS Grid/Flexbox: Modern layout techniques for responsive design
  • Progressive Enhancement: Core content accessible without JavaScript
  • Semantic HTML: Proper heading hierarchy and accessibility features

Content Sections

  1. Overview - Introduction to Claude Code philosophy and core features
  2. Commands - Comprehensive slash command reference
  3. Setup & Configuration - Environment optimization and MCP setup
  4. CLAUDE.md Files - Project configuration best practices
  5. Workflows - Proven development patterns and methodologies
  6. Safety & Permissions - Security considerations and permission management
  7. Advanced Features - Custom commands and MCP integration
  8. Pro Tips - Performance optimization and expert guidance

Maintenance Guidelines

  • Keep content synchronized with official Claude Code documentation
  • Maintain single-file architecture for portability
  • Test across different browsers and devices
  • Validate HTML and CSS for standards compliance
  • Ensure all interactive features degrade gracefully

IMPORTANT Notes

  • This is a static reference guide - no build process or dependencies required
  • All content is embedded within the HTML file for maximum portability
  • The guide is designed to be shared easily via file transfer or hosting
  • Interactive features use standard web APIs for broad compatibility