229 lines
7.3 KiB
Markdown
Executable file
229 lines
7.3 KiB
Markdown
Executable file
# Achille Press - PaperMod Inspired WordPress Theme
|
|
|
|
A fast, clean, and responsive WordPress theme inspired by the Hugo PaperMod theme. Built on the Underscores (_s) foundation with modern design principles and enhanced user experience.
|
|
|
|
## ✨ Features
|
|
|
|
### Design & Layout
|
|
- **Clean, minimal design** inspired by PaperMod
|
|
- **Responsive layout** that works on all devices
|
|
- **Light/Dark theme toggle** for improved accessibility
|
|
- **Typography-focused** with excellent readability
|
|
- **Card-based post layouts** with hover effects
|
|
- **Breadcrumb navigation** for better UX
|
|
- **Archive pages** with elegant post listings
|
|
|
|
### Navigation & Menus
|
|
- **Clean header** with site title and navigation
|
|
- **Mobile-responsive menu** with hamburger toggle
|
|
- **Search functionality** (if search plugins are available)
|
|
- **Social media icons** in header/footer
|
|
- **Menu location indicators** for active pages
|
|
|
|
### Content Features
|
|
- **Post meta information** (date, author, categories, tags)
|
|
- **Reading time estimation** for posts
|
|
- **Share buttons** for social media
|
|
- **Related posts** suggestions
|
|
- **Table of contents** generation for long posts
|
|
- **Featured images** with responsive support
|
|
- **Code syntax highlighting** support
|
|
|
|
### Performance & SEO
|
|
- **Optimized CSS** with minimal load times
|
|
- **SEO-friendly** markup and structure
|
|
- **Schema markup** for better search results
|
|
- **Fast loading** with optimized assets
|
|
|
|
## 🎯 Changes from Original Underscores Theme
|
|
|
|
### Theme Information Updates
|
|
1. **Theme name**: Changed from "_s" to "Achille Press"
|
|
2. **Theme description**: Updated to reflect PaperMod inspiration
|
|
3. **Author information**: Updated theme metadata
|
|
|
|
### Color Scheme & Typography
|
|
4. **Color palette**: Implemented PaperMod-inspired color scheme
|
|
- Light theme: Clean whites and grays
|
|
- Dark theme: Dark backgrounds with light text
|
|
- Accent colors: Subtle blues and greens
|
|
5. **Typography**: Enhanced font stack with better readability
|
|
- Primary font: System fonts for performance
|
|
- Monospace: Improved code font stack
|
|
- Font sizes: Optimized hierarchy
|
|
6. **CSS Variables**: Added for theme switching and consistency
|
|
|
|
### Layout & Structure
|
|
7. **Header redesign**:
|
|
- Cleaner, more minimal header
|
|
- Better navigation placement
|
|
- Added theme toggle button
|
|
8. **Footer redesign**:
|
|
- Simplified footer with social links
|
|
- Copyright and theme attribution
|
|
9. **Content layout**:
|
|
- Wider content area
|
|
- Better spacing and margins
|
|
- Card-based post listings
|
|
10. **Sidebar handling**: Improved responsive sidebar
|
|
|
|
### Navigation Enhancements
|
|
11. **Menu styling**: PaperMod-inspired navigation
|
|
12. **Mobile menu**: Enhanced mobile navigation
|
|
13. **Breadcrumbs**: Added breadcrumb navigation
|
|
14. **Search integration**: Improved search functionality
|
|
|
|
### Post & Page Templates
|
|
15. **Post meta**: Enhanced post metadata display
|
|
16. **Reading time**: Added reading time estimation
|
|
17. **Share buttons**: Social media sharing options
|
|
18. **Related posts**: Post suggestions at end of articles
|
|
19. **Archive pages**: Improved archive and category pages
|
|
20. **Featured images**: Better featured image handling
|
|
|
|
### Components & Widgets
|
|
21. **Button styles**: PaperMod-inspired buttons
|
|
22. **Form elements**: Styled form inputs and fields
|
|
23. **Code blocks**: Enhanced code syntax styling
|
|
24. **Quote blocks**: Improved blockquote styling
|
|
25. **Widget areas**: Updated widget styling
|
|
|
|
### JavaScript Features
|
|
26. **Theme toggle**: Light/dark mode switching
|
|
27. **Smooth scrolling**: Enhanced page navigation
|
|
28. **Mobile menu**: Improved mobile interactions
|
|
29. **Search enhancement**: Better search UX
|
|
|
|
### Performance Optimizations
|
|
30. **CSS optimization**: Minimized and organized styles
|
|
31. **Font loading**: Optimized web font loading
|
|
32. **Image handling**: Responsive image improvements
|
|
33. **JavaScript**: Minimized JS footprint
|
|
|
|
### Accessibility Improvements
|
|
34. **ARIA labels**: Enhanced accessibility markup
|
|
35. **Keyboard navigation**: Improved keyboard support
|
|
36. **Screen reader**: Better screen reader support
|
|
37. **Color contrast**: Improved contrast ratios
|
|
|
|
### WooCommerce Integration
|
|
38. **Product styling**: PaperMod-inspired product layouts
|
|
39. **Cart/Checkout**: Enhanced e-commerce pages
|
|
40. **Shop styling**: Improved shop page design
|
|
|
|
### Additional Features
|
|
41. **Social icons**: Added social media icon support
|
|
42. **Schema markup**: Enhanced SEO markup
|
|
43. **Custom post types**: Better CPT support
|
|
44. **Language support**: RTL and multilingual improvements
|
|
|
|
## 🛠️ Installation
|
|
|
|
### Requirements
|
|
|
|
Achille Press requires the following dependencies:
|
|
|
|
- [Node.js](https://nodejs.org/) (for SASS compilation)
|
|
- [Composer](https://getcomposer.org/) (for PHP dependencies)
|
|
- WordPress 5.6 or higher
|
|
- PHP 7.4 or higher
|
|
|
|
### Quick Start
|
|
|
|
1. Download or clone this repository to your WordPress themes directory
|
|
2. Install dependencies:
|
|
```sh
|
|
$ composer install
|
|
$ npm install
|
|
```
|
|
3. Compile the styles:
|
|
```sh
|
|
$ npm run compile:css
|
|
```
|
|
4. Activate the theme in WordPress admin
|
|
|
|
### Development Setup
|
|
|
|
To start developing with all the available tools:
|
|
$ npm install
|
|
```
|
|
|
|
### Available CLI commands
|
|
|
|
Achille Press comes with CLI commands for development:
|
|
|
|
- `composer lint:wpcs` : checks PHP files against WordPress Coding Standards
|
|
- `composer lint:php` : checks PHP files for syntax errors
|
|
- `composer make-pot` : generates translation files
|
|
- `npm run compile:css` : compiles SASS files to CSS
|
|
- `npm run compile:rtl` : generates RTL stylesheet
|
|
- `npm run watch` : watches SASS files and recompiles on changes
|
|
- `npm run lint:scss` : checks SASS files against CSS standards
|
|
- `npm run lint:js` : checks JavaScript files against standards
|
|
- `npm run bundle` : creates distribution archive
|
|
|
|
## 🎨 Customization
|
|
|
|
### Theme Options
|
|
The theme includes several customization options accessible through the WordPress Customizer:
|
|
|
|
- **Colors**: Light/Dark theme colors
|
|
- **Typography**: Font selections and sizes
|
|
- **Layout**: Sidebar options and content width
|
|
- **Header**: Logo, navigation, and search options
|
|
- **Footer**: Social links and copyright text
|
|
|
|
### Custom CSS
|
|
Additional CSS can be added through:
|
|
- WordPress Customizer → Additional CSS
|
|
- Child theme stylesheet
|
|
- Custom CSS plugin
|
|
|
|
### Social Media Icons
|
|
Configure social media links in the Customizer. Supported platforms include:
|
|
- Twitter/X
|
|
- Facebook
|
|
- LinkedIn
|
|
- GitHub
|
|
- Instagram
|
|
- YouTube
|
|
- And many more...
|
|
|
|
## 🌐 Browser Support
|
|
|
|
- Chrome (latest)
|
|
- Firefox (latest)
|
|
- Safari (latest)
|
|
- Edge (latest)
|
|
- Internet Explorer 11+ (limited support)
|
|
|
|
## 📱 Mobile Responsive
|
|
|
|
Achille Press is fully responsive and optimized for:
|
|
- Desktop computers
|
|
- Tablets (portrait and landscape)
|
|
- Mobile phones (all sizes)
|
|
- High-resolution displays
|
|
|
|
## 📄 License
|
|
|
|
This theme is licensed under the GNU General Public License v2 or later.
|
|
Use it to create something amazing!
|
|
|
|
## 🤝 Contributing
|
|
|
|
Contributions are welcome! Please feel free to submit a Pull Request.
|
|
|
|
## 🐛 Bug Reports
|
|
|
|
If you find any issues, please report them on the GitHub repository.
|
|
|
|
## 🙏 Credits
|
|
|
|
- Based on [Underscores](https://underscores.me/) by Automattic
|
|
- Inspired by [Hugo PaperMod](https://github.com/adityatelange/hugo-PaperMod) theme
|
|
- Icons by [Feather Icons](https://feathericons.com/)
|
|
|
|
---
|
|
|
|
**Ready to create something awesome? Let's build a beautiful WordPress site together! 🚀**
|