grossgrade/robot-learning-tutorial
0
1# Changelog2 3All notable changes to the Research Article Template will be documented in this file.4 5The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),6and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).7 8## [Unreleased]9 10### Added11- Initial open source release12- Comprehensive documentation13- Contributing guidelines14- License file15 16## [1.0.0] - 2024-12-1917 18### Added19- **Core Features**:20 - Markdown/MDX-based writing system21 - KaTeX mathematical notation support22 - Syntax highlighting for code blocks23 - Academic citations with BibTeX integration24 - Footnotes and sidenotes system25 - Auto-generated table of contents26 - Interactive Mermaid diagrams27 - Plotly.js and D3.js integration28 - HTML embed support29 - Gradio app embedding30 - Dataviz color palettes31 - Image optimization32 - SEO-friendly structure33 - Automatic PDF export34 - Dark/light theme toggle35 - Mobile-responsive design36 - LaTeX import functionality37 - Template synchronization system38 39- **Components**:40 - Figure component with captions41 - MultiFigure for image galleries42 - Note component with variants43 - Quote component44 - Accordion for collapsible content45 - Sidenote component46 - Table of Contents47 - Theme Toggle48 - HTML Embed49 - Raw HTML support50 - SEO component51 - Hero section52 - Footer53 - Full-width and wide layouts54 55- **Build System**:56 - Astro 4.10.0 integration57 - PostCSS with custom media queries58 - Automatic compression59 - Docker support60 - Nginx configuration61 - Git LFS support62 63- **Scripts**:64 - PDF export functionality65 - LaTeX to MDX conversion66 - Template synchronization67 - Font SVG generation68 - TrackIO data generation69 70- **Documentation**:71 - Getting started guide72 - Writing best practices73 - Component reference74 - LaTeX conversion guide75 - Interactive examples76 77### Technical Details78- **Framework**: Astro 4.10.079- **Styling**: PostCSS with custom properties80- **Math**: KaTeX 0.16.2281- **Charts**: Plotly.js 3.1.0, D3.js 7.9.082- **Diagrams**: Mermaid 11.10.183- **Node.js**: >=20.0.084- **License**: CC-BY-4.085 86### Browser Support87- Chrome (latest)88- Firefox (latest)89- Safari (latest)90- Edge (latest)91 92---93 94## Version History95 96- **1.0.0**: Initial stable release with full feature set97- **0.0.1**: Development version (pre-release)98 99## Migration Guide100 101### From 0.0.1 to 1.0.0102 103This is the first stable release. No breaking changes from the development version.104 105### Updating Your Project106 107Use the template synchronization system to update:108 109```bash110npm run sync:template -- --dry-run # Preview changes111npm run sync:template # Apply updates112```113 114## Support115 116- **Documentation**: [Hugging Face Space](https://huggingface.co/spaces/tfrere/research-article-template)117- **Issues**: [Community Discussions](https://huggingface.co/spaces/tfrere/research-article-template/discussions)118- **Contact**: [@tfrere](https://huggingface.co/tfrere)119 