This repository has been archived by the owner on Nov 9, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a Module.md description for coming documentation on modules [#125]
- Loading branch information
Showing
1 changed file
with
24 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Modules | ||
|
||
The WebBlocks semantics are organized in a series of modules. Each module is a | ||
logical subdivision that contains a number of definitions. | ||
|
||
Top-level modules includes: | ||
|
||
* `base` - Foundational elements that establish a grid, colors and provide | ||
utilities for floating, visibility, image replacement and other such things. | ||
This namespace should almost always be included in a WebBlocks build. | ||
* `entity` - Common user interface elements including styled versions of | ||
HTML base elements elements such as lists, tables, blockquotes and buttons, as | ||
well as more complex elements such as headers and navs. This namespace is | ||
generally included in a WebBlocks build, and many of its components require the | ||
`base` namespace. | ||
* `extend` - More advanced elements that enhance the user experience such as a | ||
scrollable table. This namespace is not always included in full, but rather | ||
individual modules are often selected. In many cases, elements within the | ||
`extend` namespace require components from the `entity` namespace to work | ||
correctly. | ||
|
||
During the build process, these modules may be enabled or disabled through the | ||
`WebBlocks.config[:src][:modules]` directive. See the Configuration | ||
documentation for more information. |