Skip to content

Finetune the frontend docs #506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 8, 2025
Merged

Finetune the frontend docs #506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/src/.vitepress/cache/deps/_metadata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"vue": {
"src": "../../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
"file": "vue.js",
"fileHash": "d9ca7532",
"fileHash": "41af724b",
"needsInterop": false
},
"vitepress > @vue/devtools-api": {
Expand All @@ -19,13 +19,13 @@
"vitepress > @vueuse/core": {
"src": "../../../../node_modules/@vueuse/core/index.mjs",
"file": "vitepress___@vueuse_core.js",
"fileHash": "670b8f6c",
"fileHash": "1b9d83a4",
"needsInterop": false
},
"vitepress > @vueuse/integrations/useFocusTrap": {
"src": "../../../../node_modules/@vueuse/integrations/useFocusTrap.mjs",
"file": "vitepress___@vueuse_integrations_useFocusTrap.js",
"fileHash": "534edfcb",
"fileHash": "e9e4c80e",
"needsInterop": false
},
"vitepress > mark.js/src/vanilla.js": {
Expand Down
6 changes: 5 additions & 1 deletion docs/src/frontend/components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,8 @@ next:
link: '/frontend/accordion'
---

# Introduction to the components
# Frontend components

These docs describe the JavaScript framework used in this Craft Base Install. All components are custom, self‑written and maintained, and implemented in TypeScript.

Browse all components using the sidebar. If you're a colleague and have questions, contact Karel‑Jan. If you like this setup or have suggestions, please open an issue on GitHub: [open an issue](https://github.com/statikbe/craft/issues)
6 changes: 6 additions & 0 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Statik's Craft Base install

Welcome to the documentation of the [Statik](https://www.statik.be) Craft base install.

- [Go to the frontend docs](/frontend/components.html)
- [Go to the craft docs](/craft/about.html)
102 changes: 100 additions & 2 deletions docs/vite.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,56 @@ export default ({ command }) => ({
/\n@source "..\/..\/..\/vendor\/statikbe\/craft-cookie-banner\/src";/g,
'\n/* @source "../../../vendor/statikbe/craft-cookie-banner/src"; */'
)
.replace(/\n@source "..\/..\/..\/templates\/_site";/g, '\n/* @source "../../../templates/_site"; */');
.replace(/\n@source "..\/..\/..\/templates\/_site";/g, '\n/* @source "../../../templates/_site"; */')
.replace(
"\n/* @import './components/flatpickr.css' layer(components); */",
"\n@import './components/flatpickr.css' layer(components);"
)
.replace(
"\n/* @import './components/leaflet.css' layer(components); */",
"\n@import './components/leaflet.css' layer(components);"
)
.replace(
"\n/* @import './components/masonry.css' layer(components); */",
"\n@import './components/masonry.css' layer(components);"
)
.replace(
"\n/* @import './components/range-slider.css' layer(components); */",
"\n@import './components/range-slider.css' layer(components);"
)
.replace(
"\n/* @import './components/tippy.css' layer(components); */",
"\n@import './components/tippy.css' layer(components);"
)
.replace(
'\n/* @source "../../js/components-base/ajaxSearch.component.ts"; */',
'\n@source "../../js/components-base/ajaxSearch.component.ts";'
)
.replace(
'\n/* @source "../../js/components-base/autocomplete.component.ts"; */',
'\n@source "../../js/components-base/autocomplete.component.ts";'
)
.replace(
'\n/* @source "../../js/components-base/chip.component.ts"; */',
'\n@source "../../js/components-base/chip.component.ts";'
)
.replace(
'\n/* @source "../../js/components-base/modal.component.ts"; */',
'\n@source "../../js/components-base/modal.component.ts";'
)
.replace('\n/* @source "../../js/plugins/modal"; */', '\n@source "../../js/plugins/modal";')
.replace(
'\n/* @source "../../js/components-base/videoBackground.component.ts"; */',
'\n@source "../../js/components-base/videoBackground.component.ts";'
)
.replace(
'\n/* @source "../../js/components-base/videoToggle.component.ts"; */',
'\n@source "../../js/components-base/videoToggle.component.ts";'
)
.replace(
'\n/* @source "../../js/plugins/validation/passwordStrength.component.ts"; */',
'\n@source "../../js/plugins/validation/passwordStrength.component.ts";'
);
fs.writeFileSync(cssFilePath, updatedCssContent, 'utf8');
console.log('CSS File changed:', cssFilePath);
} else {
Expand All @@ -55,7 +104,56 @@ export default ({ command }) => ({
/\n\/\* @source "..\/..\/..\/vendor\/statikbe\/craft-cookie-banner\/src"; \*\//g,
'\n@source "../../../vendor/statikbe/craft-cookie-banner/src";'
)
.replace(/\n\/\* @source "..\/..\/..\/templates\/_site"; \*\//g, '\n@source "../../../templates/_site";');
.replace(/\n\/\* @source "..\/..\/..\/templates\/_site"; \*\//g, '\n@source "../../../templates/_site";')
.replace(
"\n@import './components/flatpickr.css' layer(components);",
"\n/* @import './components/flatpickr.css' layer(components); */"
)
.replace(
"\n@import './components/leaflet.css' layer(components);",
"\n/* @import './components/leaflet.css' layer(components); */"
)
.replace(
"\n@import './components/masonry.css' layer(components);",
"\n/* @import './components/masonry.css' layer(components); */"
)
.replace(
"\n@import './components/range-slider.css' layer(components);",
"\n/* @import './components/range-slider.css' layer(components); */"
)
.replace(
"\n@import './components/tippy.css' layer(components);",
"\n/* @import './components/tippy.css' layer(components); */"
)
.replace(
'\n@source "../../js/components-base/ajaxSearch.component.ts";',
'\n/* @source "../../js/components-base/ajaxSearch.component.ts"; */'
)
.replace(
'\n@source "../../js/components-base/autocomplete.component.ts";',
'\n/* @source "../../js/components-base/autocomplete.component.ts"; */'
)
.replace(
'\n@source "../../js/components-base/chip.component.ts";',
'\n/* @source "../../js/components-base/chip.component.ts"; */'
)
.replace(
'\n@source "../../js/components-base/modal.component.ts";',
'\n/* @source "../../js/components-base/modal.component.ts"; */'
)
.replace('\n@source "../../js/plugins/modal";', '\n/* @source "../../js/plugins/modal"; */')
.replace(
'\n@source "../../js/components-base/videoBackground.component.ts";',
'\n/* @source "../../js/components-base/videoBackground.component.ts"; */'
)
.replace(
'\n@source "../../js/components-base/videoToggle.component.ts";',
'\n/* @source "../../js/components-base/videoToggle.component.ts"; */'
)
.replace(
'\n@source "../../js/plugins/validation/passwordStrength.component.ts";',
'\n/* @source "../../js/plugins/validation/passwordStrength.component.ts"; */'
);
fs.writeFileSync(cssFilePath, updatedCssContent, 'utf8');
console.log('CSS File changed:', cssFilePath);
} else {
Expand Down
1 change: 0 additions & 1 deletion frontend/css/site/main.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
@import './utilities/pullout.css';

@source "../../../templates/_site";
@source "../../../templates/jsPlugins";
@source "../../../vendor/statikbe/craft-cookie-banner/src";
/* @source "../../../docs/src"; */

Expand Down
16 changes: 3 additions & 13 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4626,9 +4626,9 @@ supports-preserve-symlinks-flag@^1.0.0:
integrity sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==

swiper@^11.2.0:
version "11.2.10"
resolved "https://registry.yarnpkg.com/swiper/-/swiper-11.2.10.tgz#ed0b17286b56f7fe8d4b46ed61e6e0bd8daaccad"
integrity sha512-RMeVUUjTQH+6N3ckimK93oxz6Sn5la4aDlgPzB+rBrG/smPdCTicXyhxa+woIpopz+jewEloiEE3lKo1h9w2YQ==
version "11.2.3"
resolved "https://registry.yarnpkg.com/swiper/-/swiper-11.2.3.tgz#6358e8169dcd78fc1dffb65bb29b5875c7bcedcc"
integrity sha512-24m5tqHCd1Wmp9+86aKDoIGMsZGEjIL++3nuB1UjhAhIlvwj4k0Jikxu9PGQ/VswLpoje6JtMDWo12uu4aS2FA==

systemjs@^6.15.1:
version "6.15.1"
Expand All @@ -4655,16 +4655,6 @@ tapable@^2.2.0:
resolved "https://registry.yarnpkg.com/tapable/-/tapable-2.2.1.tgz#1967a73ef4060a82f12ab96af86d52fdb76eeca0"
integrity sha512-GNzQvQTOIP6RyTfE2Qxb8ZVlNmw0n88vp1szwWRimP02mnTsx3Wtn5qRdqY9w2XduFNUgvOwhNnQsjwCp+kqaQ==

swiper@^11.2.0:
version "11.2.3"
resolved "https://registry.yarnpkg.com/swiper/-/swiper-11.2.3.tgz#6358e8169dcd78fc1dffb65bb29b5875c7bcedcc"
integrity sha512-24m5tqHCd1Wmp9+86aKDoIGMsZGEjIL++3nuB1UjhAhIlvwj4k0Jikxu9PGQ/VswLpoje6JtMDWo12uu4aS2FA==

symbol-tree@^3.2.4:
version "3.2.4"
resolved "https://registry.yarnpkg.com/symbol-tree/-/symbol-tree-3.2.4.tgz#430637d248ba77e078883951fb9aa0eed7c63fa2"
integrity sha512-9QNk5KwDF+Bvz+PyObkmSYjI5ksVUYtjW7AU22r2NKcfLJcXp96hkDWU3+XndOsUb+AQ9QhfzfCT2O+CNWT5Tw==

tar-fs@^2.0.0, tar-fs@^2.1.1:
version "2.1.2"
resolved "https://registry.yarnpkg.com/tar-fs/-/tar-fs-2.1.2.tgz#425f154f3404cb16cb8ff6e671d45ab2ed9596c5"
Expand Down