44 lines
1.0 KiB
Markdown
44 lines
1.0 KiB
Markdown
|
October CMS Webpack Theme Boilerplate
|
||
|
|
==========
|
||
|
|
|
||
|
|
This is an example theme for October CMS that includes:
|
||
|
|
|
||
|
|
- Webpack (using Laravel Mix)
|
||
|
|
|
||
|
|
To use it:
|
||
|
|
|
||
|
|
- [Install October CMS](https://octobercms.com/docs/setup/installation)
|
||
|
|
- Create a new folder in October /themes folder (call it for example my-awesome-theme)
|
||
|
|
- Clone the repo in your theme folder
|
||
|
|
- Activate the theme from October backend settings
|
||
|
|
|
||
|
|
To modify it:
|
||
|
|
|
||
|
|
- Open a terminal, go to your theme folder and run `npm install` (node_modules folder will be created)
|
||
|
|
- Install more packages using `npm install --save`
|
||
|
|
- Require your installed packages in src/js/app.js
|
||
|
|
- Modify the js and scss files
|
||
|
|
- Run `npm run dev` (`npm run watch` to recompile when something changes)
|
||
|
|
- [Add new pages, partials, content files...](https://octobercms.com/docs/cms/themes)
|
||
|
|
|
||
|
|
When you are ready for production:
|
||
|
|
|
||
|
|
- Run `npm run prod`
|
||
|
|
|
||
|
|
|
||
|
|
## To add ajax framework
|
||
|
|
|
||
|
|
```sh
|
||
|
|
npm install jquery
|
||
|
|
```
|
||
|
|
|
||
|
|
Add framework tag to `layouts/default.htm`:
|
||
|
|
|
||
|
|
```
|
||
|
|
<script src="{{ this.layout.scripts }}"></script>
|
||
|
|
|
||
|
|
{% framework extras %}
|
||
|
|
|
||
|
|
{% scripts %}
|
||
|
|
```
|