Skip to content

Commit 2f59912

Browse files
committed
Add README for dist/ folder with usage instructions
- Complete documentation for ready-to-use production build - CDN usage examples with jsDelivr links - Deployment instructions for all hosting scenarios - File inventory and technical specifications - Quick start guide for immediate usage
1 parent 2151077 commit 2f59912

File tree

1 file changed

+106
-0
lines changed

1 file changed

+106
-0
lines changed

dist/README.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# AdminLTE v4.0.0-rc3 - Production Build
2+
3+
This folder contains the **ready-to-use production build** of AdminLTE v4.0.0-rc3.
4+
5+
## 🚀 Quick Start
6+
7+
### Option 1: Download & Use Locally
8+
1. Download this entire `dist/` folder
9+
2. Upload to your web server or open `index.html` in a local server
10+
3. All files work immediately - no build process required!
11+
12+
### Option 2: Use as CDN
13+
```html
14+
<!-- CSS -->
15+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/ColorlibHQ/[email protected]/dist/css/adminlte.min.css">
16+
17+
<!-- JavaScript -->
18+
<script src="https://cdn.jsdelivr.net/gh/ColorlibHQ/[email protected]/dist/js/adminlte.min.js"></script>
19+
```
20+
21+
## 📁 What's Included
22+
23+
### 📄 **HTML Pages (37 total)**
24+
- `index.html` - Main dashboard
25+
- `index2.html`, `index3.html` - Alternative dashboards
26+
- `widgets/` - Widget demonstrations
27+
- `layout/` - Layout examples (sidebar variations, RTL, etc.)
28+
- `forms/` - Form examples
29+
- `tables/` - Table examples
30+
- `UI/` - UI component examples
31+
- `examples/` - Login, register, lockscreen pages
32+
- `docs/` - Documentation pages
33+
34+
### 🎨 **CSS Files**
35+
- `css/adminlte.css` - Main stylesheet
36+
- `css/adminlte.min.css` - Minified version
37+
- `css/adminlte.rtl.css` - Right-to-left language support
38+
- `css/adminlte.rtl.min.css` - RTL minified
39+
- `css/*.map` - Source maps for debugging
40+
41+
### **JavaScript Files**
42+
- `js/adminlte.js` - Main JavaScript
43+
- `js/adminlte.min.js` - Minified version
44+
- `js/*.map` - Source maps for debugging
45+
46+
### 🖼️ **Assets**
47+
- `assets/img/` - All images (logos, avatars, photos, etc.)
48+
- Complete image set for demos and examples
49+
50+
## 🌍 **Deployment**
51+
52+
### **Works Everywhere**
53+
- **Static Hosting**: GitHub Pages, Netlify, Vercel, Surge.sh
54+
- **Traditional Hosting**: cPanel, FTP servers, shared hosting
55+
- **CDN**: Use files directly via jsDelivr or GitHub Pages
56+
- **Sub-folders**: Works in any directory structure
57+
58+
### **Production Ready**
59+
- Optimized CSS and JavaScript (minified versions available)
60+
- All relative paths work regardless of deployment location
61+
- Images load correctly from any hosting scenario
62+
- Zero configuration required
63+
64+
## 🔧 **Technical Details**
65+
66+
### Dependencies (Loaded from CDN)
67+
- **Bootstrap**: 5.3.7
68+
- **Bootstrap Icons**: 1.13.1
69+
- **OverlayScrollbars**: 2.11.0
70+
- **PopperJS**: 2.11.8
71+
72+
### Browser Support
73+
- Chrome (latest)
74+
- Firefox (latest)
75+
- Safari (latest)
76+
- Edge (latest)
77+
78+
### Features
79+
- **Fully Responsive** - Works on all screen sizes
80+
- **Dark/Light Mode** - Automatic system preference detection
81+
- **RTL Support** - Complete right-to-left language support
82+
- **Accessibility** - WCAG 2.1 AA compliant
83+
- **No Build Required** - Ready to use immediately
84+
85+
## 🆕 **What's New in v4.0.0-rc3**
86+
87+
-**Fixed Production Builds** - Resolved all deployment path issues
88+
-**Sidebar Navigation** - Fixed badges, arrows, and spacing
89+
-**Smart Path Resolution** - Works in any deployment scenario
90+
-**Updated Dependencies** - Latest stable versions of all libraries
91+
-**Zero Console Errors** - Clean, professional runtime experience
92+
93+
## 📖 **Documentation**
94+
95+
- [Live Demo](https://adminlte.io/themes/v4/)
96+
- [GitHub Repository](https://github.com/ColorlibHQ/AdminLTE)
97+
- [Changelog](https://github.com/ColorlibHQ/AdminLTE/blob/master/CHANGELOG.md)
98+
99+
## 📄 **License**
100+
101+
MIT License - see [LICENSE](https://github.com/ColorlibHQ/AdminLTE/blob/master/LICENSE) file for details.
102+
103+
---
104+
105+
**AdminLTE** - Free Bootstrap 5 Admin Dashboard Template
106+
Created by [AdminLTE.io](https://adminlte.io) | [ColorlibHQ](https://colorlib.com)

0 commit comments

Comments
 (0)