NCP Stampede Documentation Website

This repository hosts the official documentation website for the NCP Stampede high school sports toolkit ecosystem. The website provides comprehensive documentation for both the HS Scraper Toolkit (Python) and Frontend Package (Flutter).

🌐 Live Website

Visit the documentation at: https://ncp-stampede.github.io

📚 What's Documented

HS Scraper Toolkit

• Python package for scraping athletic data from MaxPreps and Athletic.net
• Complete API reference and usage examples
• Installation and setup instructions
• Data structure documentation

Frontend Package

• Flutter UI components and theme system
• Customizable widgets for school athletics apps
• Responsive design utilities
• Integration examples

🛠️ Website Features

• Modern Design: Clean, responsive design optimized for all devices
• Interactive Examples: Syntax-highlighted code examples with copy functionality
• Comprehensive Navigation: Easy-to-use navigation with scroll progress
• Mobile-Friendly: Fully responsive design with mobile hamburger menu
• Fast Loading: Optimized static site with modern web technologies

🔧 Technologies Used

• HTML5: Semantic markup structure
• CSS3: Modern styling with Grid and Flexbox
• JavaScript: Interactive features and navigation
• Prism.js: Syntax highlighting for code examples
• Inter Font: Clean, readable typography
• GitHub Pages: Static site hosting

📁 Repository Structure

├── index.html          # Main documentation page
├── styles/
│   └── main.css        # All styling and responsive design
├── scripts/
│   └── main.js         # Interactive functionality
├── README.md           # This file
└── LICENSE             # MIT License

🚀 Local Development

To run the website locally:

1. Clone this repository:

   git clone https://github.com/NCP-Stampede/NCP-Stampede.github.io.git
   cd NCP-Stampede.github.io

2. Serve the files using any local server:

   # Using Python
   python -m http.server 8000
   
   # Using Node.js
   npx serve .
   
   # Using VS Code Live Server extension
   # Right-click index.html and select "Open with Live Server"

3. Open your browser to http://localhost:8000

📝 Contributing

We welcome contributions to improve the documentation:

1. Fork this repository
2. Create a feature branch: git checkout -b improve-docs
3. Make your changes
4. Test locally to ensure everything works
5. Commit your changes: git commit -m "Improve documentation"
6. Push to your fork: git push origin improve-docs
7. Submit a pull request

🔗 Related Repositories

• HS App Toolkit: Python scraping toolkit
• Frontend Package: Flutter UI components

📄 License

This documentation website is licensed under the MIT License - see the LICENSE file for details.

🤝 Support

• Issues: Report bugs or suggest improvements on GitHub Issues
• Discussions: Ask questions on our GitHub Discussions
• Email: Contact us at stampede.ncp@gmail.com