106 lines
3.8 KiB
Markdown
106 lines
3.8 KiB
Markdown
|
# Pugz Documentation Index
|
||
|
|
|
||
|
|
Complete documentation for the Pugz template engine.
|
||
|
|
|
||
|
|
## Getting Started
|
||
|
|
|
||
|
|
| Document | Description |
|
||
|
|
|----------|-------------|
|
||
|
|
| **[README.md](../README.md)** | Project overview and quick start |
|
||
|
|
| **[CLAUDE.md](CLAUDE.md)** | Development guide for contributors |
|
||
|
|
| **[api.md](api.md)** | API reference |
|
||
|
|
| **[syntax.md](syntax.md)** | Pug syntax guide |
|
||
|
|
|
||
|
|
## Examples & Guides
|
||
|
|
|
||
|
|
| Document | Description |
|
||
|
|
|----------|-------------|
|
||
|
|
| **[EXAMPLES.md](EXAMPLES.md)** | Complete examples overview with quick navigation |
|
||
|
|
| **[DEMO_SERVER.md](DEMO_SERVER.md)** | HTTP server example with runtime and compiled templates |
|
||
|
|
| **[CLI_TEMPLATES_DEMO.md](CLI_TEMPLATES_DEMO.md)** | Complete feature reference and examples |
|
||
|
|
| **[FEATURES_REFERENCE.md](FEATURES_REFERENCE.md)** | Detailed feature guide with all supported Pug syntax |
|
||
|
|
| **[PUGJS_COMPATIBILITY.md](PUGJS_COMPATIBILITY.md)** | Feature-by-feature comparison with official Pug.js |
|
||
|
|
|
||
|
|
## Compiled Templates
|
||
|
|
|
||
|
|
| Document | Description |
|
||
|
|
|----------|-------------|
|
||
|
|
| **[COMPILED_TEMPLATES.md](COMPILED_TEMPLATES.md)** | Overview of compiled template feature |
|
||
|
|
| **[COMPILED_TEMPLATES_STATUS.md](COMPILED_TEMPLATES_STATUS.md)** | Implementation status and roadmap |
|
||
|
|
| **[CLI_TEMPLATES_COMPLETE.md](CLI_TEMPLATES_COMPLETE.md)** | CLI tool completion summary |
|
||
|
|
|
||
|
|
## Testing & Verification
|
||
|
|
|
||
|
|
| Document | Description |
|
||
|
|
|----------|-------------|
|
||
|
|
| **[VERIFICATION.md](VERIFICATION.md)** | Test results, memory leak checks, code quality verification |
|
||
|
|
| **[BUILD_SUMMARY.md](BUILD_SUMMARY.md)** | Build system cleanup and completion summary |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Quick Links by Topic
|
||
|
|
|
||
|
|
### Learning Pugz
|
||
|
|
|
||
|
|
1. Start with [README.md](../README.md) - Project overview
|
||
|
|
2. Read [syntax.md](syntax.md) - Pug syntax basics
|
||
|
|
3. Check [EXAMPLES.md](EXAMPLES.md) - Working examples
|
||
|
|
4. See [FEATURES_REFERENCE.md](FEATURES_REFERENCE.md) - Complete feature guide
|
||
|
|
|
||
|
|
### Using Pugz
|
||
|
|
|
||
|
|
1. **Runtime mode:** [api.md](api.md) - Basic API usage
|
||
|
|
2. **Compiled mode:** [COMPILED_TEMPLATES.md](COMPILED_TEMPLATES.md) - Performance mode
|
||
|
|
3. **Web servers:** [DEMO_SERVER.md](DEMO_SERVER.md) - HTTP integration
|
||
|
|
4. **All features:** [CLI_TEMPLATES_DEMO.md](CLI_TEMPLATES_DEMO.md) - Complete examples
|
||
|
|
|
||
|
|
### Contributing
|
||
|
|
|
||
|
|
1. Read [CLAUDE.md](CLAUDE.md) - Development rules and guidelines
|
||
|
|
2. Check [BUILD_SUMMARY.md](BUILD_SUMMARY.md) - Build system structure
|
||
|
|
3. Review [VERIFICATION.md](VERIFICATION.md) - Quality standards
|
||
|
|
|
||
|
|
### Compatibility
|
||
|
|
|
||
|
|
1. [PUGJS_COMPATIBILITY.md](PUGJS_COMPATIBILITY.md) - Feature comparison with Pug.js
|
||
|
|
2. [FEATURES_REFERENCE.md](FEATURES_REFERENCE.md) - What's supported
|
||
|
|
3. [COMPILED_TEMPLATES_STATUS.md](COMPILED_TEMPLATES_STATUS.md) - Compiled mode limitations
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Documentation Organization
|
||
|
|
|
||
|
|
All documentation is organized in the `docs/` directory:
|
||
|
|
|
||
|
|
```
|
||
|
|
docs/
|
||
|
|
├── INDEX.md # This file
|
||
|
|
├── CLAUDE.md # Development guide
|
||
|
|
├── api.md # API reference
|
||
|
|
├── syntax.md # Pug syntax guide
|
||
|
|
├── EXAMPLES.md # Examples overview
|
||
|
|
├── DEMO_SERVER.md # HTTP server guide
|
||
|
|
├── CLI_TEMPLATES_DEMO.md # CLI examples
|
||
|
|
├── FEATURES_REFERENCE.md # Complete feature reference
|
||
|
|
├── PUGJS_COMPATIBILITY.md # Pug.js compatibility
|
||
|
|
├── COMPILED_TEMPLATES.md # Compiled templates overview
|
||
|
|
├── COMPILED_TEMPLATES_STATUS.md # Implementation status
|
||
|
|
├── CLI_TEMPLATES_COMPLETE.md # CLI completion summary
|
||
|
|
├── VERIFICATION.md # Test verification
|
||
|
|
└── BUILD_SUMMARY.md # Build system summary
|
||
|
|
```
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## External Resources
|
||
|
|
|
||
|
|
- **Official Pug Documentation:** https://pugjs.org/
|
||
|
|
- **Zig Language:** https://ziglang.org/
|
||
|
|
- **GitHub Repository:** (your repo URL)
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
**Last Updated:** 2026-01-28
|
||
|
|
**Pugz Version:** 1.0
|
||
|
|
**Zig Version:** 0.15.2
|