File size: 2,963 Bytes
e86b529 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
# Changelog
All notable changes to the Research Article Template will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- Initial open source release
- Comprehensive documentation
- Contributing guidelines
- License file
## [1.0.0] - 2024-12-19
### Added
- **Core Features**:
- Markdown/MDX-based writing system
- KaTeX mathematical notation support
- Syntax highlighting for code blocks
- Academic citations with BibTeX integration
- Footnotes and sidenotes system
- Auto-generated table of contents
- Interactive Mermaid diagrams
- Plotly.js and D3.js integration
- HTML embed support
- Gradio app embedding
- Dataviz color palettes
- Image optimization
- SEO-friendly structure
- Automatic PDF export
- Dark/light theme toggle
- Mobile-responsive design
- LaTeX import functionality
- Template synchronization system
- **Components**:
- Figure component with captions
- MultiFigure for image galleries
- Note component with variants
- Quote component
- Accordion for collapsible content
- Sidenote component
- Table of Contents
- Theme Toggle
- HTML Embed
- Raw HTML support
- SEO component
- Hero section
- Footer
- Full-width and wide layouts
- **Build System**:
- Astro 4.10.0 integration
- PostCSS with custom media queries
- Automatic compression
- Docker support
- Nginx configuration
- Git LFS support
- **Scripts**:
- PDF export functionality
- LaTeX to MDX conversion
- Template synchronization
- Font SVG generation
- TrackIO data generation
- **Documentation**:
- Getting started guide
- Writing best practices
- Component reference
- LaTeX conversion guide
- Interactive examples
### Technical Details
- **Framework**: Astro 4.10.0
- **Styling**: PostCSS with custom properties
- **Math**: KaTeX 0.16.22
- **Charts**: Plotly.js 3.1.0, D3.js 7.9.0
- **Diagrams**: Mermaid 11.10.1
- **Node.js**: >=20.0.0
- **License**: CC-BY-4.0
### Browser Support
- Chrome (latest)
- Firefox (latest)
- Safari (latest)
- Edge (latest)
---
## Version History
- **1.0.0**: Initial stable release with full feature set
- **0.0.1**: Development version (pre-release)
## Migration Guide
### From 0.0.1 to 1.0.0
This is the first stable release. No breaking changes from the development version.
### Updating Your Project
Use the template synchronization system to update:
```bash
npm run sync:template -- --dry-run # Preview changes
npm run sync:template # Apply updates
```
## Support
- **Documentation**: [Hugging Face Space](https://huggingface.co/spaces/tfrere/research-article-template)
- **Issues**: [Community Discussions](https://huggingface.co/spaces/tfrere/research-article-template/discussions)
- **Contact**: [@tfrere](https://huggingface.co/tfrere)
|