btk-webpack
v2.0.2
Published
BTK is a light module for Magnolia CMS with a basic set of templates ideal to start new website project based on Bootstrap framework.
Downloads
24
Readme
BTK Webpack - Bootstrap Templating Kit for Magnolia CMS with Webpack
Create simple websites with Magnolia CMS and Bootstrap with help of Webpack.
Developed on Magnolia 6.2.7. Using Bootstrap 4.3.1 and Webpack 4.35.0.
If something doesn’t work, please contact us:
- Tomáš Gregovský [email protected]
- Bartosz Staryga [email protected]
Installation
Magnolia CLI
Run in Magnolia's folder:
mgnl install btk-webpack
or
Git
Clone BTK Webpack repository into Magnolia's light modules folder.
User Guide
When creating new page Home [#btk-webpack], Page [#btk-webpack] and Search [#btk-webpack] templates will be available.
Use Home [#btk-webpack] for root page, Page [#btk-webpack] for subpages. Search [#btk-webpack] as a root child will enable search functionality.
Demo page
Inside the module you can find BTK-Webpack-Template demo page that is fully build with BTK Webpack. Demo page serves also as full documentation on BTK Webpack's page templates and components.
To see demo page you have to:
- import
/btk-webpack/demo/dam.BTK-Webpack-Template.xml
into dam workspace (remember to import into folder and then move it to root) - import
/btk-webpack/demo/website.BTK-Webpack-Template.xml
into website workspace
What’s Included?
Your module will have everything you need to build a modern website with Magnolia CMS and Bootstrap.
Pages:
- Home
- Page
- Search
Components:
- Accordion
- Button
- Card
- Carousel
- Divider
- Heading
- Image
- Jumbotron
- Modal
- Row
- Text
Source files
Compile Bootstrap with Webpack by using source Sass, JavaScript files in webresources-src
.
npm i
npm run build
This setup allows you to keep components' scss
and js
files inside component folder. Remember to import them inside webpack entry points index.scss
and index.js
respectively.
Check Divider component to see this in use.
This set up allows you to run in dev
mode.
npm start
Changelog
2.0.2
- Updated dialogs definitions for new UI in Magnolia 6.2.x
2.0.1
- Bootstrap 4.3.1
License
This project is open source software licensed as MIT.