Cubane Documentation¶
The cubane documentation is organised into the following sections. You may want to get right into the code by following the tutorials or deep dive into individual topics:
- Getting Started gives you a quick introduction to cubane and what it is all about. Start here if want to find out what cubane is actually for. We take you by the hand through a series of step by step walkthroughs and tutorials.
- Topic guides discuss key topics and concepts at a high level and provide useful background information and explanation.
- Looking for specific information? Try the Index, Module Index or the detailed table of contents.
- Reference guides contain a technical reference for APIs and other aspects of Cubane. They describe how it works and how to use it but assume that you have a basic understanding of key concepts.
- Getting started
- Topics
- Resources
- Requirements
- What the Resource Management System does
- Declaring Resources
- Declaring Resource Buckets
- Including Resources
- Inline Resources
- External CSS
- External Javascript
- Declaring CSS Resources
- Declaring Javascript Resources
- Declaring Font Resources
- Declaring Resources with Absolute Path
- Declaring Media Resources
- Declaring External Resources
- Pattern Expansion
- Resource Templates
- Using RequireJS
- Fonts
- SVG Icons
- Media
- Introduction to Media Content
- Loading Media Assets
- Lazy Loading
- Media Loader
- Rendering Media Assets
- Plain Image
- Lazy Loaded Image
- Responsive Image Sizes
- Maximum Image Width
- Image Shapes
- Image Shape Names
- Image Shape CSS
- Lightbox
- Background Images
- Size Templates
- Art Direction
- Art Direction and CSS Classes
- SVG Vector Images
- Media URLs
- Media API URLs
- Embedding SVG Images
- SVG-based clip paths
- Backend System
- Content Management
- Enquiry Forms
- Favourite Icon
- Modules and Extensions
- Settings
- Default Settings
- Installed Apps
- Setup Template Context Processors
- System Settings
- Cubane Base Path Settings
- Timezone, Language and Formatting Settings
- Backend Settings
- Authentication Settings
- Static Assets Settings
- Favicon Settings
- Media Settings
- Font Settings
- CMS Settings
- Enquiry Settings
- Google Analytics
- Google Maps
- Pagination Settings
- Captcha Settings
- Email Settings
- Test Settings
- Deployment
- Pulling Production Data
- Testing Cubane
- Resources
- Cubane Reference