natty
/
calckey
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

feat: ✨ custom css/assets 

typo

fix gulpfile
This commit is contained in:
ThatOneCalculator 2022-08-09 02:37:12 -07:00
parent fd088d0c85
commit 73a57858e0
4 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -52,6 +52,11 @@ cp ../misskey/.config/default.yml ./.config/default.yml # replace `../misskey/`
# cp -r ../misskey/files . # if you don't use object storage # cp -r ../misskey/files . # if you don't use object storage
``` ```
## 💅 Customize
- To add custom CSS for all users, edit `/custom/instance.css`.
- To add static assets (such as images for the splash screen), place them in the `/custom/` folder. They'll then be avaliable on `https://yourinstance.tld/static-assets/filename.png`.
## 🚀 Build and launch! ## 🚀 Build and launch!
### `git pull` and run these steps to update Calckey in the future! ### `git pull` and run these steps to update Calckey in the future!

7
custom/instance.css Normal file
View File

@ -0,0 +1,7 @@
/*
* !!! WARNING !!!
* Editing this file may cause your instance to break for EVERYONE.
* Please know what you're doing and test it out with regular user custom CSS.
* With that said, GLHF!
* This may eventuallly be replaced with a function in the admin panel.
*/

7
gulpfile.js
View File

@ -15,6 +15,10 @@ gulp.task('copy:backend:views', () =>
gulp.src('./packages/backend/src/server/web/views/**/*').pipe(gulp.dest('./packages/backend/built/server/web/views')) gulp.src('./packages/backend/src/server/web/views/**/*').pipe(gulp.dest('./packages/backend/built/server/web/views'))
); );
gulp.task('copy:backend:custom', () =>
gulp.src('./custom/*').pipe(gulp.dest('./packages/backend/assets/'))
);
gulp.task('copy:client:fonts', () => gulp.task('copy:client:fonts', () =>
gulp.src('./packages/client/node_modules/three/examples/fonts/**/*').pipe(gulp.dest('./built/_client_dist_/fonts/')) gulp.src('./packages/client/node_modules/three/examples/fonts/**/*').pipe(gulp.dest('./built/_client_dist_/fonts/'))
); );
@ -35,6 +39,7 @@ gulp.task('copy:client:locales', cb => {
cb(); cb();
}); });
gulp.task('build:backend:script', () => { gulp.task('build:backend:script', () => {
return gulp.src(['./packages/backend/src/server/web/boot.js', './packages/backend/src/server/web/bios.js', './packages/backend/src/server/web/cli.js']) return gulp.src(['./packages/backend/src/server/web/boot.js', './packages/backend/src/server/web/bios.js', './packages/backend/src/server/web/cli.js'])
.pipe(replace('LANGS', JSON.stringify(Object.keys(locales)))) .pipe(replace('LANGS', JSON.stringify(Object.keys(locales))))
@ -53,7 +58,7 @@ gulp.task('build:backend:style', () => {
}); });
gulp.task('build', gulp.parallel( gulp.task('build', gulp.parallel(
'copy:client:locales', 'copy:backend:views', 'build:backend:script', 'build:backend:style', 'copy:client:fonts', 'copy:client:fontawesome' 'copy:client:locales', 'copy:backend:views', 'copy:backend:custom', 'build:backend:script', 'build:backend:style', 'copy:client:fonts', 'copy:client:fontawesome'
)); ));
gulp.task('default', gulp.task('build')); gulp.task('default', gulp.task('build'));

1
packages/backend/src/server/web/views/base.pug
View File

@ -36,6 +36,7 @@ html
link(rel='prefetch' href='/static-assets/badges/not-found.png') link(rel='prefetch' href='/static-assets/badges/not-found.png')
link(rel='prefetch' href='/static-assets/badges/error.png') link(rel='prefetch' href='/static-assets/badges/error.png')
link(rel='stylesheet' href='/assets/fontawesome/css/all.css') link(rel='stylesheet' href='/assets/fontawesome/css/all.css')
link(rel='stylesheet' href='/static-assets/instance.css')
link(rel='modulepreload' href=`/assets/${clientEntry.file}`) link(rel='modulepreload' href=`/assets/${clientEntry.file}`)
each href in clientEntry.css each href in clientEntry.css