You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update README with comprehensive asset building instructions
- Add detailed step-by-step explanation of what 'npm run serve' does
- Include all available npm scripts with descriptions
- Update environment setup with current Node.js 20+ and Ruby 3.3+ requirements
- Add troubleshooting section for common development issues
- Clarify difference between Browsersync (localhost:3000) and Jekyll (127.0.0.1:4000)
- Improve setup instructions for version managers (nvm, rbenv)
Documentation now clearly shows how to build all assets properly.
$ bundle install# Installs Ruby gems (if not already run by npm install)
61
62
```
62
63
63
-
If you get a `jekyll-4.0.0 requires rubygems version >= 2.7.0, which is incompatible with the current version` error then try running: `gem update --system`
64
+
**Version managers (recommended):**
65
+
```bash
66
+
# For Node.js version management
67
+
$ nvm use # Uses version specified in .nvmrc
68
+
69
+
# For Ruby version management
70
+
$ rbenv install # Installs version specified in .ruby-version
71
+
$ rbenv shell # Activates the correct Ruby version
72
+
```
73
+
74
+
If you encounter a `jekyll-4.0.0 requires rubygems version >= 2.7.0` error, try: `gem update --system`
64
75
65
76
### Getting started
66
77
78
+
To build and serve the site locally with all assets:
79
+
67
80
```bash
68
81
$ npm run serve
69
-
# or
70
-
$ gulp serve
71
82
```
72
-
Compiles the compass files, javascripts, and launches the server making the site available at `http://localhost:3000/`
73
-
The system will watch files and execute tasks whenever one of them changes.
74
-
The site will automatically refresh since it is bundled with livereload.
75
83
76
-
### Other commands
84
+
This command will:
85
+
1.**Clean** previous builds
86
+
2.**Clone blog posts** from the blog repository
87
+
3.**Fetch events** data and helpers
88
+
4.**Build Jekyll** site with both `_config.yml` and `_config-dev.yml`
89
+
5.**Compile JavaScript** and process all scripts
90
+
6.**Process CSS/Styles** with modern dependencies
91
+
7.**Generate icons** and optimize images
92
+
8.**Create downloadable materials** (zip files)
93
+
9.**Copy assets** to the build directory
94
+
10.**Start Browsersync** server with file watching
77
95
78
-
Build for production:
96
+
The site will be available at:
97
+
-**Primary (Browsersync)**: `http://localhost:3000` - *Recommended for development*
98
+
-**Browsersync UI**: `http://localhost:3001` - Controls and sync options
99
+
-**Jekyll only**: `http://127.0.0.1:4000` - Basic Jekyll server
100
+
101
+
The system automatically watches files and rebuilds when changes are detected. The site will auto-refresh in your browser.
102
+
103
+
### Manual asset building
104
+
105
+
If you need to run specific build steps manually:
106
+
107
+
**Build all assets for production:**
79
108
```bash
80
109
$ npm run build
81
-
# or
82
-
$ gulp prod
110
+
# Equivalent to: gulp prod
83
111
```
84
112
85
-
Clean the compiled site:
113
+
**Clean compiled assets:**
86
114
```bash
87
115
$ npm run clean
88
-
# or
89
-
$ gulp clean
116
+
# Equivalent to: gulp clean
117
+
```
118
+
119
+
**Development build (same as serve but without server):**
120
+
```bash
121
+
$ npm run build:dev
122
+
# Equivalent to: gulp serve (without server)
90
123
```
91
124
92
-
Run tests and linting:
125
+
### Code quality and testing
126
+
127
+
**Run full test suite:**
93
128
```bash
94
129
$ npm test
95
-
$ npm run lint
130
+
# Runs linting + production build to verify everything works
131
+
```
132
+
133
+
**Lint JavaScript code:**
134
+
```bash
135
+
$ npm run lint # Check for issues
136
+
$ npm run lint:fix # Auto-fix issues where possible
96
137
```
97
138
139
+
### Troubleshooting
140
+
141
+
**Assets not loading properly:**
142
+
- Make sure you ran `npm run serve` (not just Jekyll)
143
+
- Check that both Gulp and Jekyll servers are running
144
+
- Use `http://localhost:3000` (Browsersync) instead of `http://127.0.0.1:4000` (Jekyll only)
145
+
146
+
**Build failures:**
147
+
- Try `npm run clean` then `npm run serve` to start fresh
148
+
- Ensure Node.js 20+ and Ruby 3.3+ are installed
149
+
- Check that all dependencies are up to date: `npm install && bundle install`
150
+
151
+
**Jekyll warnings about missing gems:**
152
+
- Run `bundle install` to ensure all Ruby gems are installed
153
+
- Check `.ruby-version` and use the correct Ruby version
0 commit comments