Overview

The perfect starting point for when you need to create a styleguide for your customised AtlasUI. The app uses your AtlasUI Resources Package, making it the perfect platform to test your resources as well.

Out of the box, the boilerplate offers documentation pages, guidelines and best practices, a commenting framework and even the bases for a tag-driven search.

Documentation

Description

The AtlasUI Styleguide Boilerplate is the perfect starting point for when you need to create a styleguide for your customised AtlasUI. The biggest advantage being that the styleguide app uses your AtlasUI Resources Package, making it a perfect platform to test your resources as well. Out of the box, the boilerplate offers documentation pages, guidelines and best practices, a commenting framework and even the bases for a tag-driven search. 

The fact that the styleguide application is completely build with Mendix means that any Mendix team can pick up the project and create a fully functional styleguide / testing platform for a customized AtlasUI. The example pages are added to the boilerplate to provide insight into how the app has been build and hence how to add new content to it.

Typical usage scenario

When working with a custom AtlasUI (with custom pagetemplates and building blocks), documenting those assets in a styleguide is vital for the reusability of those assets.

Features and limitations

• Pattern pages
• examples & best practices
• scaffolding for tag based search
• commenting
• resource package release platform

Note that adding content means a combination of modelling new content as well as adding data regarding that new content. e.g. A page template will have its own page, but also its own data object container information, best practices and linked content.

Dependencies

• Build with Mendix Modeler 8.0.0

Installation

• Use the application as a starting point.
• Inspect and learn how pagetemplates and building block pages work by the examples given.
• Make a temporary backup of the styleguide Sass code – located in the App layer.
• Import your own AtlasUI Resources package
• Insert the styleguide sass code back into the project (only need to do this once) and enable it.
• fix any possible bugs in the specific styleguide Sass code due to overlapping classes.
• Start adding pages.
• before exporting the AtlasUI Resources Package to a new version package, disable the styleguide sass code.

Configuration

Instead of writing a long list of how the app works, a number of example pages were created in the boilerplate to learn from. 

Frequently Asked Questions

• Q: Do I need to know how to model in Mendix to use this app?
• A: Yes, the app is just a boilerplate and adding content is a combination between modelling and adding data.