From df91cadf49068bc3cdb7c597bccf01581d335d91 Mon Sep 17 00:00:00 2001 From: Angelos Chalaris Date: Fri, 28 Apr 2017 00:25:22 +0300 Subject: [PATCH] Built navigation for core, added ids Added ids to all parts of the modules docs, linked to them through a nav sidebar in core. (Next commit will implement this for all modules) --- docs/card.html | 8 +- docs/contextual.html | 10 +- docs/core.html | 380 +++++++++++++++++++++------------------- docs/grid.html | 14 +- docs/input_control.html | 10 +- docs/navigation.html | 10 +- docs/progress.html | 10 +- docs/tab.html | 6 +- docs/table.html | 8 +- docs/utility.html | 14 +- 10 files changed, 248 insertions(+), 222 deletions(-) diff --git a/docs/card.html b/docs/card.html index e928f40..7a986ca 100644 --- a/docs/card.html +++ b/docs/card.html @@ -41,7 +41,7 @@
-
+

Card

The card module provides you with modern, responsive, general-purpose containers for your page's contents. They are very easy to use and their structure is really simple and versatile. Layouts will respond to smaller screens, realigning the cards in a manner that makes your page mobile-friendly.

@@ -64,7 +64,7 @@
-
+

Basic syntax

@@ -180,7 +180,7 @@
-
+

Sections & media

@@ -223,7 +223,7 @@
-
+

Card sizing & fluidity

diff --git a/docs/contextual.html b/docs/contextual.html index 19688c5..6b5ca50 100644 --- a/docs/contextual.html +++ b/docs/contextual.html @@ -41,7 +41,7 @@
-
+

Contextual

The contextual module provides you with simple tags, marks and highlights for your pages, allowing you to easily emphasize parts of your text. The contextual alerts aim to replace the commonly used modal dialog design paradigm with a more modern one. HTML5 elements and simple rules are used in order to make important messages and pieces of content stand out easily.

@@ -64,7 +64,7 @@
-
+

Text highlighting

@@ -123,7 +123,7 @@
-
+

Alerts

@@ -174,7 +174,7 @@
-
+

Animated alerts

@@ -210,7 +210,7 @@
-
+

Tooltips

diff --git a/docs/core.html b/docs/core.html index a586de9..14b6123 100644 --- a/docs/core.html +++ b/docs/core.html @@ -21,193 +21,219 @@ [class^='fore-'] { font-family: monospace, monospace;} .fore-primary { color: #0d47a1;} .fore-secondary { color: #b71c1c;} .fore-tertiary { color: #1b5e20;} .col-sm-12.col-sm-last.col-md-4.col-md-normal { box-sizing: border-box; border-right: 1px solid #bdbdbd; } @media (max-width: 767px){ .col-sm-12.col-sm-last.col-md-4.col-md-normal { border: 0; border-top: 1px solid #bdbdbd; } } - header.sticky a.button { padding: 4px 6px; font-size: 0.95em; } -
+
Introduction Modules Flavors Templates Customization Quick Reference  Github
-
- Core Grid - Navigation Input Control - Table Card - Tab Contextual - Progress Utility -
- -
-
-
-

Core

-

The core module contains basic reset and fix rules, based on Normalize.css v5.0.0, along with lots of custom typography rules. Most textual HTML5 elements are styled by this module, so you can start writing your pages immediately without worrying about font families, weights, sizes, line heights, paddings and the like.

-

All examples showcased refer to the mini-default flavor, some class names and styles might differ based on the flavor you're using.

-
-
-
-
-
-
-
-

Quick overview

-

Before applying any typography and styling rules, some resets need to be applied to make sure that different elements display consistently on all browsers. The core module utilizes the ruleset of Normalize.css v5.0.0 to apply those much needed resets and fixes. However, to keep the framework small, we removed some rules that only help with legacy browser support and also tweaked a lot of the rules around to use customizable variables so no duplicate rules are applied, taking up unnecessary space. The typography rules in core deal with a page's basics, like fonts and styling of headings and paragraphs, horizontal rules, colors, margins, padding etc.


-
-
-

Quick start

-

To use the core module, simply include the link to the flavor you are using and start writing your HTML page as usual. One suggestion we will make is to add the following line inside your HTML page's <head> to utilize the viewport meta tag:


- 
<meta name="viewport" content="width=device-width, initial-scale=1">

-
-
-
-
-
-
-
-

Typography

-
-
-

For the basic typography rules we did the following, along with other things presented below:

-
    -
  • We use a native font stack to figure out the best font for your device.
    • -
  • We set the colors to background: #f5f5f5; and color: #212121;.
    • -
  • We use a font-size of 16px for the root element.
    • -
  • We set line-height to 1.5.
    • -
-
-
-
-
-
-
-
-
-

Headings

-
-
-

Heading 1Subheading

-

Heading 2Subheading

-

Heading 3Subheading

-

Heading 4Subheading

-
Heading 5Subheading
-
Heading 6Subheading
-
-
-

All six of the HTML headings (<h1> - <h6>) are styled with simple rules, providing a clean base for your pages' headings. Apart from the headings themselves, complementary rules are provided for <small> elements inside headings, allowing you to define subheadings or explanatory text for those headings. These subheadings are stylized to display below the headings in smaller, lighter type.

-

Sample code

- 
<h1>Heading 1<small>Subheading</small></h1>
-<h2>Heading 2<small>Subheading</small></h2>
-<h3>Heading 3<small>Subheading</small></h3>
-<h4>Heading 4<small>Subheading</small></h4>
-<h5>Heading 5<small>Subheading</small></h5>
-<h6>Heading 6<small>Subheading</small></h6>

-
-
-
-
-
-
-
-
-

Common textual elements

-
-
-

This is a paragraph with some sample text. Did you know mini.css v2.1 is codenamed Fermion? No? Well, now you do! Oh, by the way, that was some Bold text and here is some text in Italics. Maybe you want to know what our inline elements look like. For example a link to the Github repository of mini.css looks like that! Neat, right? Maybe you want to see some inline code or some sample input. Oh, also small text is cool, along with its siblings: the subscripthi! and the superscripthello!. Finally, check out the horizontal rule, preformatted code block and quotation below.

- 
function sum(num1, num2) {
-    var num3 = num1 + num2;
-    console.log('Result: ' + num3);
-}
-
This is some quoted text from elsewhere.

-
-
-
-

The most common HTML5 elements must be things like <p>aragraphs, bold (<strong>) & italics (<em>) text, links (<a>), horizontal rules (<hr>) and <small> text. These, along with a few others, are styled by default using clean, modern design to make your pages look cool and stand out from the rest of the internet.

-

Sample code

- 
<p>This is a paragraph with some <strong>bold text</strong> and some <em>italics text</em>.</p>
-<a href="#">This is a link.</a>
-<small>This is some small text.</small>
-<sub>Subscript</sub>
-<sup>Superscript</sup>
-<code>Inline code</code>
-<kbd>Keyboard Input</kbd>
-<hr>
-<pre>This is some preformatted text.</pre>
-<blockquote cite="Quotation source">
-  This is some quoted text from another website or person.
-</blockquote>

-
-
-
-
-
-
-
-
-

Lists

-
-
-

-
    -
  • Apple
    • -
  • Orange
    • -
  • Strawberry
    • -

-
    -
  1. Wake up
    2. -
  2. Eat breakfast
    3. -
  3. Go to work
    4. -

-
-
-
-

Lists are also very commonly used in websites and apps. We tweaked a few margins and paddings to save some space and make them align properly with the rest of the common HTML elements that we use, but both unordered lists (<ul>) and ordered lists (<ol>) are minimally pre-styled to make things a little bit easier for you.

-

Sample code

- 
<ul>
-  <li>Apple</li>
-  <li>Orange</li>
-  <li>Strawberry</li>
-</ul>
+		

+			
 
+				

+		      

+		        

+		          
Core

+		          
The core module contains basic reset and fix rules, based on Normalize.css v5.0.0, along with lots of custom typography rules. Most textual HTML5 elements are styled by this module, so you can start writing your pages immediately without worrying about font families, weights, sizes, line heights, paddings and the like.

+		          
All examples showcased refer to the mini-default flavor, some class names and styles might differ based on the flavor you're using.

+		          

+		        

+		      

+		      

+		        

+		          

+		            

+		              
Quick overview

+		              
Before applying any typography and styling rules, some resets need to be applied to make sure that different elements display consistently on all browsers. The core module utilizes the ruleset of Normalize.css v5.0.0 to apply those much needed resets and fixes. However, to keep the framework small, we removed some rules that only help with legacy browser support and also tweaked a lot of the rules around to use customizable variables so no duplicate rules are applied, taking up unnecessary space. The typography rules in core deal with a page's basics, like fonts and styling of headings and paragraphs, horizontal rules, colors, margins, padding etc.


+		            

+		            

+		              
Quick start

+		              
To use the core module, simply include the link to the flavor you are using and start writing your HTML page as usual. One suggestion we will make is to add the following line inside your HTML page's <head> to utilize the viewport meta tag:


+		              
<meta name="viewport" content="width=device-width, initial-scale=1">


+		            

+		          

+		        

+		      

+		      

+		        

+		          

+		            
Typography

+		            

+		              

+		                
For the basic typography rules we did the following, along with other things presented below:

+		                
    
+		                  
  • We use a native font stack to figure out the best font for your device.
    • 
+		                  
  • We set the colors to background: #f5f5f5; and color: #212121;.
    • 
+		                  
  • We use a font-size of 16px for the root element.
    • 
+		                  
  • We set line-height to 1.5.
    • 
+		                

+		              

+		            

+		          

+		        

+		      

+		      

+		        

+		          

+		            
Headings

+		            

+		              

+		                
Heading 1Subheading

+		                
Heading 2Subheading

+		                
Heading 3Subheading

+		                
Heading 4Subheading

+		                
Heading 5Subheading

+		                
Heading 6Subheading

+		              

+		              

+		                
All six of the HTML headings (<h1> - <h6>) are styled with simple rules, providing a clean base for your pages' headings. Apart from the headings themselves, complementary rules are provided for <small> elements inside headings, allowing you to define subheadings or explanatory text for those headings. These subheadings are stylized to display below the headings in smaller, lighter type.

+		                
Sample code

+		                
<h1>Heading 1<small>Subheading</small></h1>
+		<h2>Heading 2<small>Subheading</small></h2>
+		<h3>Heading 3<small>Subheading</small></h3>
+		<h4>Heading 4<small>Subheading</small></h4>
+		<h5>Heading 5<small>Subheading</small></h5>
+		<h6>Heading 6<small>Subheading</small></h6>


+		              

+		            

+		          

+		        

+		      

+		      

+		        

+		          

+		            
Common textual elements

+		            

+		              

+		                

This is a paragraph with some sample text. Did you know mini.css v2.1 is codenamed Fermion? No? Well, now you do! Oh, by the way, that was some Bold text and here is some text in Italics. Maybe you want to know what our inline elements look like. For example a link to the Github repository of mini.css looks like that! Neat, right? Maybe you want to see some inline code or some sample input. Oh, also small text is cool, along with its siblings: the subscripthi! and the superscripthello!. Finally, check out the horizontal rule, preformatted code block and quotation below.

+		                
function sum(num1, num2) {
+		    var num3 = num1 + num2;
+		    console.log('Result: ' + num3);
+		}

+		                  
This is some quoted text from elsewhere.


+		                

+		              

+		              

+		                
The most common HTML5 elements must be things like <p>aragraphs, bold (<strong>) & italics (<em>) text, links (<a>), horizontal rules (<hr>) and <small> text. These, along with a few others, are styled by default using clean, modern design to make your pages look cool and stand out from the rest of the internet.

+		                
Sample code

+		                
<p>This is a paragraph with some <strong>bold text</strong> and some <em>italics text</em>.</p>
+		<a href="#">This is a link.</a>
+		<small>This is some small text.</small>
+		<sub>Subscript</sub>
+		<sup>Superscript</sup>
+		<code>Inline code</code>
+		<kbd>Keyboard Input</kbd>
+		<hr>
+		<pre>This is some preformatted text.</pre>
+		<blockquote cite="Quotation source">
+		  This is some quoted text from another website or person.
+		</blockquote>


+		              

+		            

+		          

+		        

+		      

+		      

+		        

+		          

+		            
Lists

+		            

+		              

+		                


+		                  
    
+		                    
  • Apple
    • 
+		                    
  • Orange
    • 
+		                    
  • Strawberry
    • 
+		                  


+		                  
    
+		                    
  1. Wake up
    2. 
+		                    
  2. Eat breakfast
    3. 
+		                    
  3. Go to work
    4. 
+		                  


+		                

+		              

+		              

+		                
Lists are also very commonly used in websites and apps. We tweaked a few margins and paddings to save some space and make them align properly with the rest of the common HTML elements that we use, but both unordered lists (<ul>) and ordered lists (<ol>) are minimally pre-styled to make things a little bit easier for you.

+		                
Sample code

+		                
<ul>
+		  <li>Apple</li>
+		  <li>Orange</li>
+		  <li>Strawberry</li>
+		</ul>
 
-<ol>
-  <li>Wake up</li>
-  <li>Eat breakfast</li>
-  <li>Go to work</li>
-</ol>


-              

-            

-          

-        

-      

-      

-        

-          

-            
Image responsiveness & captions

-            

-              

-                
Image caption

-              

-              

-                
Image elements (<img>) are responsive by default, without the need for any special classes or anything else. We made sure they will scale down as necessary to display properly on smaller devices, while keeping their original aspect ratio, but they will never scale up above their original size.
 
On a side note, if you want to add captions to images, you can use a <figcaption> element, while wrapping both the image and it inside a <figure>.

-                
Sample code

-                
<figure>
-  <img src="...">
-  <figcaption>Image caption</figcaption>
-</figure>


-              

-            

-          

-        

-      

-      

-        

-          
If you want to learn more about mini.css's modules, go back to the modules page and choose another module to see its documentation.

-        

-      

-
- + <ol> + <li>Wake up</li> + <li>Eat breakfast</li> + <li>Go to work</li> + </ol>
+
+
+
+
+
+
+
+
+

Image responsiveness & captions

+
+
+
Image caption
+
+
+

Image elements (<img>) are responsive by default, without the need for any special classes or anything else. We made sure they will scale down as necessary to display properly on smaller devices, while keeping their original aspect ratio, but they will never scale up above their original size.

On a side note, if you want to add captions to images, you can use a <figcaption> element, while wrapping both the image and it inside a <figure>.

+

Sample code

+ 
<figure>
+		  <img src="...">
+		  <figcaption>Image caption</figcaption>
+		</figure>

+
+
+
+
+
+
+
+

If you want to learn more about mini.css's modules, go back to the modules page and choose another module to see its documentation.

+
+
+
diff --git a/docs/grid.html b/docs/grid.html index 6453f8f..b75b836 100644 --- a/docs/grid.html +++ b/docs/grid.html @@ -43,7 +43,7 @@
-
+

Grid

The grid module provides you with a modern, responsive grid system based on the Flexible Layout Module (commonly known as flexbox). The structure of the grid is simple and logical, allowing you to quickly build your pages from scratch. Setting the layout for a page is easy and will behave the way you want them to on mobile devices and smaller screens.

@@ -66,7 +66,7 @@
-
+

Basic layout

@@ -240,7 +240,7 @@
-
+

Screen-specific layouts

@@ -336,7 +336,7 @@
-
+

Predefined layouts

@@ -393,7 +393,7 @@
-
+

Column offsets

@@ -466,7 +466,7 @@
-
+

Column reordering

@@ -540,7 +540,7 @@
-
+

Media object pattern

diff --git a/docs/input_control.html b/docs/input_control.html index ea0a3b0..a93b458 100644 --- a/docs/input_control.html +++ b/docs/input_control.html @@ -42,7 +42,7 @@
-
+

Input Control

The input_control module contains rules that affect forms, input elements, buttons, checkboxes and radio buttons. All of these elements' styles are predefined, allowing you to create modern, responsive forms quickly. Layout alternatives are also provided if you want your forms to look a certain way.

@@ -65,7 +65,7 @@
-
+

Forms & input

@@ -237,7 +237,7 @@
-
+

Checkboxes & radio buttons

@@ -325,7 +325,7 @@
-
+

Buttons & button groups

@@ -406,7 +406,7 @@
-
+

File upload buttons

diff --git a/docs/navigation.html b/docs/navigation.html index 176c91b..fa0f918 100644 --- a/docs/navigation.html +++ b/docs/navigation.html @@ -41,7 +41,7 @@
-
+
-
+ -
+ -
+ -
+

Sticky headers and footers

diff --git a/docs/progress.html b/docs/progress.html index e534131..2815629 100644 --- a/docs/progress.html +++ b/docs/progress.html @@ -43,7 +43,7 @@
-
+

Progress

The progress module gives you full control over the presentation of progress and loading on your pages. Apart from progress bars and color variants for them, spinner elements are provided to help communicate that something is loading.

@@ -66,7 +66,7 @@
-
+

Basic progress bar

@@ -104,7 +104,7 @@
-
+

Progress bar variants

@@ -147,7 +147,7 @@
-
+

Donut spinner

@@ -183,7 +183,7 @@
-
+

Donut spinner variants

diff --git a/docs/tab.html b/docs/tab.html index 6329e51..0389711 100644 --- a/docs/tab.html +++ b/docs/tab.html @@ -41,7 +41,7 @@
-
+

Tab

The tab module aims to combine multiple components and design paradigms, like collapses, accordions, carousels and tabs, into one general-purpose component. Tabs are very simple in structure, responsive on mobile and they allow for layout customization so that you can turn them into accordions or collapses whenever you want.

@@ -64,7 +64,7 @@
-
+

Basic syntax

@@ -180,7 +180,7 @@
-
+

Stacked tabs

diff --git a/docs/table.html b/docs/table.html index 8fb8597..7194e85 100644 --- a/docs/table.html +++ b/docs/table.html @@ -47,7 +47,7 @@
-
+

Table

The table module provides styling and responsiveness for tables. Simple rules and accessible design paradigms have been used to make creating tables quick and easy. Large tables will collapse to cards when on smaller devices or, if you don't want that, they can be locked into their default, desktop view.

@@ -70,7 +70,7 @@
-
+

Basic syntax & responsiveness

@@ -197,7 +197,7 @@
-
+
@@ -274,7 +274,7 @@
-
+

Table variants & matrices

diff --git a/docs/utility.html b/docs/utility.html index fa802b1..a987887 100644 --- a/docs/utility.html +++ b/docs/utility.html @@ -41,7 +41,7 @@
-
+

Utility

The utility module contains all the utilities and helper classes that you might want when designing a website or application. They solve common design problems efficiently and provide you with generic rules you can easily apply everywhere.

@@ -64,7 +64,7 @@
-
+

Visibility helpers

@@ -91,7 +91,7 @@
-
+

Generic borders & shadows

@@ -140,7 +140,7 @@
-
+

Responsive sizing & spacing classes

@@ -168,7 +168,7 @@
-
+

Responsive visibility helpers

@@ -216,7 +216,7 @@
-
+ -
+

Close icon