diff --git a/docs/build-docs.js b/docs/build-docs.js index 2bc5829..28e2062 100644 --- a/docs/build-docs.js +++ b/docs/build-docs.js @@ -53,7 +53,7 @@ function buildFragment(fragment){

${fragment.title}

${fragment.description}
${fragment.example?`

Example

${fragment.example}
`:''} - ${fragment.samples.length?`

Sample code

${fragment.samples.join('
')}
`:''} + ${fragment.samples.length?`

Sample code

${fragment.samples.join('')}
`:''} ${fragment.dos.length||fragment.donts.length? `

Best practices

${[fragment.dos.map(d => `
${d.sample}

Do: ${d.description}

`).join('
'),fragment.donts.map(d => `
${d.sample}

Don't: ${d.description}

`).join('
')].join('')}
` :''} diff --git a/docs/doc-fragments/codeAndQuotations.js b/docs/doc-fragments/codeAndQuotations.js new file mode 100644 index 0000000..4f68831 --- /dev/null +++ b/docs/doc-fragments/codeAndQuotations.js @@ -0,0 +1,51 @@ +module.exports = { + id: 'code-and-quotations', + title: 'Code & quotations', + keywords: [`code`, `pre`, `kbd`, `blockquote`, `quotation`], + description: '

Code blocks and quotation elements are styled using custom rules that help make them stand out from the rest of the text, while inline code and keyboard input tags are styled in a similar manner, while aiming not to break the flow of regular text.

', + example: `

This is some text with some inline source code and some keyboard input.

+ 
function sum(num1, num2){
+  return num1 + num2;
+}
+
This is some text quoted from elsewhere.
`, + samples: [ +`
<p>This is some text with some inline <code>source code</code> and some keyboard <kbd>input</kbd>.</p>
+<pre>function sum(num1, num2){
+  return num1 + num2;
+}</pre>
+<blockquote cite="www.quotation.source">This is some text quoted from elsewhere.</blockquote>
` + ], + notes: [ +`The cite attribute of <blockquote> elements is not mandatory and can be omitted. The element's sizing will be automatically adjusted according to the presence of the cite attribute.` + ], + customization: [ + `Text color can be changed globally by changing the value of the --fore-color variable. This will affect the text color of <code> and <pre> elements and background color of <kbd> elements.`, + `Background color can be changed globally by changing the value of the --back-color variable. This will affect the background color of <blockquote> elements and text color of <kbd>.`, + `You can change the background color of <code> and <pre> elements by changing the value of the --secondary-back-color variable.`, + `You can change the text color of <blockquote> elements by changing the value of the --secondary-fore-color variable.`, + `You can change the border color of <pre> and <blockquote> elements by changing the value of the --secondary-border-color variable.`, + `You can change the border color of the left border of <pre> elements by changing the value of the --pre-color variable.`, + `You can change the border color of the left border of <blockquote> elements by changing the value of the --blockquote-color variable.`, + `Universal margin for elements can be changed globally by changing the value of the --universal-margin variable. As a rule of thumb, consider the universal margin to be the distance you want your paragraphs to have from the sides of the screen.`, + `Universal padding for elements can be changed globally by changing the value of the --universal-padding variable.`, + `Universal border radius for elements can be changed globally by changing the value of the --universal-border-radius variable.` + ], + modifiers: [], + dos: [], + donts: [] +} + +/* + Modifiers: + { + title : '', + description: '', + example: '', + samples: [] + } + Dos/Donts: + { + description: '', + sample: '' + } +*/ diff --git a/docs/doc-fragments/commonTextualElements.js b/docs/doc-fragments/commonTextualElements.js index b7b376d..db747ac 100644 --- a/docs/doc-fragments/commonTextualElements.js +++ b/docs/doc-fragments/commonTextualElements.js @@ -5,7 +5,7 @@ module.exports = { keywords: ['p', 'paragraph', 'text', 'textual elements', 'strong', 'bold', 'b', 'em', 'i', 'emphasis', 'italics', 'small', 'a', 'link', 'hr', 'horizontal rule', 'sub', 'subscript', 'sup', 'exponent', 'superscript', 'normalize', 'reset'], description: `

mini.css utilizes the ruleset of Normalize.css v7.0.0 to reliably deal with inconsistencies between browsers, ensuring that your web apps will look beatiful no matter on what browser or device you're at. On top of these rules, we have applied some tasteful rules, such as using native font stack to figure out the best font for each device, slightly altering the background and foreground colors, as well as setting the size of the text to 16px and its line height to 1.5.

All of the most common HTML5 elements, such as paragraphs, links, bold, small and slanted text, have been styled by default using clean, modern typography to make your pages look cool and stand out from the rest of the internet.

`, - example: `

This is a paragraph with some sample text. Did you know that the latest version of mini.css is codenamed Gluon? Well, now you do!

Remember that mini.css is totally free, no fine print involved!

`, + example: `

This is a paragraph with some sample text. Did you know that the latest version of mini.css is codenamed Gluon? Well, now you do!

Remember that mini.css is totally free, no fine print involved!

`, samples: [ `
<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>
@@ -20,9 +20,10 @@ module.exports = {
   customization: [
     `Text color can be changed globally by changing the value of the --fore-color variable.`,
     `Background color can be changed globally by changing the value of the --back-color variable.`,
+    `Border color can be changed globally by changing the value of the --border-color variable. This affects the color of <hr> elements.`,
     `Universal margin for elements can be changed globally by changing the value of the --universal-margin variable. As a rule of thumb, consider the universal margin to be the distance you want your paragraphs to have from the sides of the screen.`,
     `Universal padding for elements can be changed globally by changing the value of the --universal-padding variable.`,
-    `You can change the color of linkss by changing the values of the --a-link-color and --a-visited-color variables.`
+    `You can change the color of links by changing the values of the --a-link-color and --a-visited-color variables.`
   ],
   modifiers: [],
   dos: [],
diff --git a/docs/doc-fragments/docFragments.js b/docs/doc-fragments/docFragments.js
index 8fa98ec..d100d2f 100644
--- a/docs/doc-fragments/docFragments.js
+++ b/docs/doc-fragments/docFragments.js
@@ -1,6 +1,10 @@
 var gettingStarted = require('./gettingStarted');
 var commonTextualElements = require('./commonTextualElements');
+var headings = require('./headings');
+var lists = require('./lists');
+var images = require('./images');
+var codeAndQuotations = require('./codeAndQuotations');
 
 module.exports = [
-  gettingStarted, commonTextualElements
+  gettingStarted, commonTextualElements, images, lists, codeAndQuotations
 ]
diff --git a/docs/doc-fragments/headings.js b/docs/doc-fragments/headings.js
new file mode 100644
index 0000000..151079d
--- /dev/null
+++ b/docs/doc-fragments/headings.js
@@ -0,0 +1,31 @@
+module.exports = {
+  id: 'heading',
+  title: 'Headings',
+  keywords: [`heading`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `small`, `title`, `subtitle`, `subheading`],
+  description: `
All of the HTML5 heading elements are styled, using a customizable ratio and simple rules, providing a clean base for your web app's titles. Apart from the headings themselves, customized rules are provided for displaying subheadings or explanatory text below your web app's headings.
`,
+  example: `
Heading 1Subheading

+  
Heading 2Subheading

+  
Heading 3Subheading

+  
Heading 4Subheading

+  
Heading 5Subheading

+  
Heading 6Subheading
`,
+  samples: [
+`
<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>

+`
+  ],
+  notes: [],
+  customization: [
+    `Text color can be changed globally by changing the value of the --fore-color variable. This will affect the color of the headings' main text.`,
+    `Secondary text color can be changed globally by changing the value of the --secondary-fore-color variable. This will affect the color of subheadings.`,
+    `Universal margin for elements can be changed globally by changing the value of the --universal-margin variable. As a rule of thumb, consider the universal margin to be the distance you want your paragraphs to have from the sides of the screen.`,
+    `You can change the ratio of headings' size by chaning the value of the --heading-ratio variable. Bear in mind that the value of this variable must be unitless to work properly.`
+  ],
+  modifiers: [],
+  dos: [],
+  donts: []
+}
diff --git a/docs/doc-fragments/images.js b/docs/doc-fragments/images.js
new file mode 100644
index 0000000..73974ee
--- /dev/null
+++ b/docs/doc-fragments/images.js
@@ -0,0 +1,20 @@
+module.exports = {
+  id: 'images-captions',
+  title: 'Images & captions',
+  keywords: [`img`, `image`, `responsive`, `responsiveness`, `caption`, `figure`, `figcaption`],
+  description: `
Image elements are responsive by default, without the need for any special classes or anything similar. They automatically scale down as necessary to display properly on smaller devices, while retaining their original aspect ratio, while they will never scale above their original size.

+  
If you want to add captions to images, you can use HTML5 figure elements, along with their related captions.
`,
+  example: '
placeholder
Image caption
',
+  samples: [`
<img src="image.png" alt="Image description"/>
`,
+`
<figure>
+  <img src="image.png" alt="Image description"/>
+  <figcaption>Image caption</figcaption>
+</figure>
`],
+  notes: [`While not mandatory, it is considered a good practice to always add a alt attribute to image elements on your web apps.`],
+  customization: [
+    `You can change the text color of <figcaption> elements by changing the value of the --secondary-fore-color variable.`
+  ],
+  modifiers: [],
+  dos: [],
+  donts: []
+}
diff --git a/docs/doc-fragments/lists.js b/docs/doc-fragments/lists.js
new file mode 100644
index 0000000..dc1570f
--- /dev/null
+++ b/docs/doc-fragments/lists.js
@@ -0,0 +1,28 @@
+module.exports = {
+  id: 'lists',
+  title: 'Lists',
+  keywords: [`list`, `ul`, `ol`, `li`],
+  description: `
List elements, both unordered and ordered, are minimally styled to match with the rest of the framework's aesthetics. Their margins and padding are reset to properly align with the rest of the common HTML5 elements, providing a stable foundation for all of your web app's lists.
`,
+  example: `

+  
  1. Wake up
  2. Eat breakfast
  3. Go to work
`,
+  samples: [`
<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>
`],
+  notes: [],
+  customization: [
+    `Text color can be changed globally by changing the value of the --fore-color variable.`,
+    `Background color can be changed globally by changing the value of the --back-color variable.`,
+    `Universal margin for elements can be changed globally by changing the value of the --universal-margin variable. As a rule of thumb, consider the universal margin to be the distance you want your paragraphs to have from the sides of the screen.`,
+    `Universal padding for elements can be changed globally by changing the value of the --universal-padding variable.`
+  ],
+  modifiers: [],
+  dos: [],
+  donts: []
+}
diff --git a/docs/v3/DEVLOG.md b/docs/v3/DEVLOG.md
index c737f27..fa9aabf 100644
--- a/docs/v3/DEVLOG.md
+++ b/docs/v3/DEVLOG.md
@@ -155,3 +155,10 @@
 - Added the `getting-started` section to the documentation, this should now start to look like a real website.
 - Worked on documentation and custom tool, it should now support a lot of the data that is thrown at it.
 - Fixed a huge bug that I expected to blow up in my face eventually, where I had removed the `max-width` propert from `.col-` elements. Everything should be bug-free in the `grid` components now.
+
+## 20171115
+
+- Documented headings.
+- Documented code and quotations.
+- Documented lists.
+- Documented images.
diff --git a/docs/v3/docs.html b/docs/v3/docs.html
index 9ade2f9..746b7ad 100644
--- a/docs/v3/docs.html
+++ b/docs/v3/docs.html
@@ -47,7 +47,7 @@
   
Common textual elements

   
mini.css utilizes the ruleset of Normalize.css v7.0.0 to reliably deal with inconsistencies between browsers, ensuring that your web apps will look beatiful no matter on what browser or device you're at. On top of these rules, we have applied some tasteful rules, such as using native font stack to figure out the best font for each device, slightly altering the background and foreground colors, as well as setting the size of the text to 16px and its line height to 1.5.

   
All of the most common HTML5 elements, such as paragraphs, links, bold, small and slanted text, have been styled by default using clean, modern typography to make your pages look cool and stand out from the rest of the internet.

-  
Example
This is a paragraph with some sample text. Did you know that the latest version of mini.css is codenamed Gluon? Well, now you do!
Remember that mini.css is totally free, no fine print involved!

+  
Example
This is a paragraph with some sample text. Did you know that the latest version of mini.css is codenamed Gluon? Well, now you do!
Remember that mini.css is totally free, no fine print involved!

   
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>
@@ -59,6 +59,52 @@
   font-size: 14px;
 }
Don't: Avoid altering the base font size of 16px directly in your CSS code, as it can cause problems with the display of certain elements.

   
-  
Customization

+  
Customization

+

+  
Images & captions

+  
Image elements are responsive by default, without the need for any special classes or anything similar. They automatically scale down as necessary to display properly on smaller devices, while retaining their original aspect ratio, while they will never scale above their original size.

+  
If you want to add captions to images, you can use HTML5 figure elements, along with their related captions.

+  
Example
placeholder
Image caption

+  
Sample code
<img src="image.png" alt="Image description"/>
<figure>
+  <img src="image.png" alt="Image description"/>
+  <figcaption>Image caption</figcaption>
+</figure>

+  
+  
Notes
  • While not mandatory, it is considered a good practice to always add a alt attribute to image elements on your web apps.

+  
Customization
  • You can change the text color of <figcaption> elements by changing the value of the --secondary-fore-color variable.

+


+  
Lists

+  
List elements, both unordered and ordered, are minimally styled to match with the rest of the framework's aesthetics. Their margins and padding are reset to properly align with the rest of the common HTML5 elements, providing a stable foundation for all of your web app's lists.

+  
Example
  • Apple
  • Orange
  • Strawberry


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

+  
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>

+  
+  
+  
Customization
  • Text color can be changed globally by changing the value of the --fore-color variable.
  • Background color can be changed globally by changing the value of the --back-color variable.
  • Universal margin for elements can be changed globally by changing the value of the --universal-margin variable. As a rule of thumb, consider the universal margin to be the distance you want your paragraphs to have from the sides of the screen.
  • Universal padding for elements can be changed globally by changing the value of the --universal-padding variable.

+


+  
Code & quotations

+  
Code blocks and quotation elements are styled using custom rules that help make them stand out from the rest of the text, while inline code and keyboard input tags are styled in a similar manner, while aiming not to break the flow of regular text.

+  
Example
This is some text with some inline source code and some keyboard input.

+  
function sum(num1, num2){
+  return num1 + num2;
+}

+
This is some text quoted from elsewhere.

+  
Sample code
<p>This is some text with some inline <code>source code</code> and some keyboard <kbd>input</kbd>.</p>
+<pre>function sum(num1, num2){
+  return num1 + num2;
+}</pre>
+<blockquote cite="www.quotation.source">This is some text quoted from elsewhere.</blockquote>

+  
+  
Notes
  • The cite attribute of <blockquote> elements is not mandatory and can be omitted. The element's sizing will be automatically adjusted according to the presence of the cite attribute.

+  
Customization
  • Text color can be changed globally by changing the value of the --fore-color variable. This will affect the text color of <code> and <pre> elements and background color of <kbd> elements.
  • Background color can be changed globally by changing the value of the --back-color variable. This will affect the background color of <blockquote> elements and text color of <kbd>.
  • You can change the background color of <code> and <pre> elements by changing the value of the --secondary-back-color variable.
  • You can change the text color of <blockquote> elements by changing the value of the --secondary-fore-color variable.
  • You can change the border color of <pre> and <blockquote> elements by changing the value of the --secondary-border-color variable.
  • You can change the border color of the left border of <pre> elements by changing the value of the --pre-color variable.
  • You can change the border color of the left border of <blockquote> elements by changing the value of the --blockquote-color variable.
  • Universal margin for elements can be changed globally by changing the value of the --universal-margin variable. As a rule of thumb, consider the universal margin to be the distance you want your paragraphs to have from the sides of the screen.
  • Universal padding for elements can be changed globally by changing the value of the --universal-padding variable.
  • Universal border radius for elements can be changed globally by changing the value of the --universal-border-radius variable.

 

   
\ No newline at end of file