mirror of
https://github.com/Chalarangelo/mini.css.git
synced 2025-08-11 08:23:58 +02:00
Core documentation
Documented all the elements in the core module. Everything works as expected so far.
This commit is contained in:
Angelos Chalaris
51
docs/doc-fragments/codeAndQuotations.js
Normal file
51
docs/doc-fragments/codeAndQuotations.js
Normal file
@@ -0,0 +1,51 @@
|
||||
module.exports = {
|
||||
id: 'code-and-quotations',
|
||||
title: 'Code & quotations',
|
||||
keywords: [`code`, `pre`, `kbd`, `blockquote`, `quotation`],
|
||||
description: '<p>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.</p>',
|
||||
example: `<p class="doc">This is some text with some inline <code class="doc">source code</code> and some keyboard <kbd class="doc">input</kbd>.</p>
|
||||
<pre class="doc">function sum(num1, num2){
|
||||
return num1 + num2;
|
||||
}</pre>
|
||||
<blockquote cite="www.quotation.source" class="doc">This is some text quoted from elsewhere.</blockquote>`,
|
||||
samples: [
|
||||
`<pre><span class="code-line"><span class="highlight-a"><p></span>This is some text with some inline <span class="highlight-a"><code></span>source code<span class="highlight-a"></code></span> and some keyboard <span class="highlight-a"><kbd></span>input<span class="highlight-a"></kbd></span>.<span class="highlight-a"></p></span></span>
|
||||
<span class="code-line"><span class="highlight-a"><pre></span>function sum(num1, num2){</span>
|
||||
<span class="code-line"> return num1 + num2;</span>
|
||||
<span class="code-line">}<span class="highlight-a"></pre></span></span>
|
||||
<span class="code-line"><span class="highlight-a"><blockquote</span> <span class="highlight-b">cite</span>=<span class="highlight-c">"www.quotation.source"</span><span class="highlight-a">></span>This is some text quoted from elsewhere.<span class="highlight-a"></blockquote></span></span></pre>`
|
||||
],
|
||||
notes: [
|
||||
`The <code>cite</code> attribute of <code><blockquote></code> elements is not mandatory and can be omitted. The element's sizing will be automatically adjusted according to the presence of the <code>cite</code> attribute.`
|
||||
],
|
||||
customization: [
|
||||
`Text color can be changed globally by changing the value of the <code>--fore-color</code> variable. This will affect the text color of <code><code></code> and <code><pre></code> elements and background color of <code><kbd></code> elements.`,
|
||||
`Background color can be changed globally by changing the value of the <code>--back-color</code> variable. This will affect the background color of <code><blockquote></code> elements and text color of <code><kbd></code>.`,
|
||||
`You can change the background color of <code><code></code> and <code><pre></code> elements by changing the value of the <code>--secondary-back-color</code> variable.`,
|
||||
`You can change the text color of <code><blockquote></code> elements by changing the value of the <code>--secondary-fore-color</code> variable.`,
|
||||
`You can change the border color of <code><pre></code> and <code><blockquote></code> elements by changing the value of the <code>--secondary-border-color</code> variable.`,
|
||||
`You can change the border color of the left border of <code><pre></code> elements by changing the value of the <code>--pre-color</code> variable.`,
|
||||
`You can change the border color of the left border of <code><blockquote></code> elements by changing the value of the <code>--blockquote-color</code> variable.`,
|
||||
`Universal margin for elements can be changed globally by changing the value of the <code>--universal-margin</code> 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 <code>--universal-padding</code> variable.`,
|
||||
`Universal border radius for elements can be changed globally by changing the value of the <code>--universal-border-radius</code> variable.`
|
||||
],
|
||||
modifiers: [],
|
||||
dos: [],
|
||||
donts: []
|
||||
}
|
||||
|
||||
/*
|
||||
Modifiers:
|
||||
{
|
||||
title : '',
|
||||
description: '',
|
||||
example: '',
|
||||
samples: []
|
||||
}
|
||||
Dos/Donts:
|
||||
{
|
||||
description: '',
|
||||
sample: ''
|
||||
}
|
||||
*/
|
||||
@@ -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: `<p><strong>mini.css</strong> utilizes the ruleset of <a href="http://necolas.github.io/normalize.css/" targe="_blank">Normalize.css</a> 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 <a href="https://www.smashingmagazine.com/2015/11/using-system-ui-fonts-practical-guide/" target="_blank">native font stack</a> 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 <code>16px</code> and its line height to <code>1.5</code>.</p>
|
||||
<p>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.</p>`,
|
||||
example: `<p>This is a paragraph with some sample text. Did you know that the latest version of <strong>mini.css</strong> is codenamed <em>Gluon</em>? Well, now you do!</p><hr/><p><small>Remember that <strong>mini.css</strong> is totally free, no fine print involved!</small></p>`,
|
||||
example: `<p class="doc">This is a paragraph with some sample text. Did you know that the latest version of <strong class="doc">mini.css</strong> is codenamed <em class="doc">Gluon</em>? Well, now you do!</p><hr class="doc"/><p><small class="doc">Remember that <strong class="doc">mini.css</strong> is totally free, no fine print involved!</small></p>`,
|
||||
samples: [
|
||||
`<pre><span class="code-line"><span class="highlight-a"><p></span>This is a paragraph. with some <span class="highlight-a"><strong></span>bold text<span class="highlight-a"></strong></span> and some <span class="highlight-a"><em></span>italics text<span class="highlight-a"></em></span>.<span class="highlight-a"></p></span></span>
|
||||
<span class="code-line"><span class="highlight-a"><a</span> <span class="highlight-b">href</span>=<span class="highlight-c">"#"</span><span class="highlight-a">></span>This is a link.<span class="highlight-a"></a></span></span>
|
||||
@@ -20,9 +20,10 @@ module.exports = {
|
||||
customization: [
|
||||
`Text color can be changed globally by changing the value of the <code>--fore-color</code> variable.`,
|
||||
`Background color can be changed globally by changing the value of the <code>--back-color</code> variable.`,
|
||||
`Border color can be changed globally by changing the value of the <code>--border-color</code> variable. This affects the color of <code><hr></code> elements.`,
|
||||
`Universal margin for elements can be changed globally by changing the value of the <code>--universal-margin</code> 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 <code>--universal-padding</code> variable.`,
|
||||
`You can change the color of linkss by changing the values of the <code>--a-link-color</code> and <code>--a-visited-color</code> variables.`
|
||||
`You can change the color of links by changing the values of the <code>--a-link-color</code> and <code>--a-visited-color</code> variables.`
|
||||
],
|
||||
modifiers: [],
|
||||
dos: [],
|
||||
|
||||
@@ -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
|
||||
]
|
||||
|
||||
31
docs/doc-fragments/headings.js
Normal file
31
docs/doc-fragments/headings.js
Normal file
@@ -0,0 +1,31 @@
|
||||
module.exports = {
|
||||
id: 'heading',
|
||||
title: 'Headings',
|
||||
keywords: [`heading`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `small`, `title`, `subtitle`, `subheading`],
|
||||
description: `<p>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.</p>`,
|
||||
example: `<div class="row"><div class="col-sm-12 col-md-6 col-md-first"><h1 class="doc">Heading 1<small class="doc">Subheading</small></h1></div>
|
||||
<div class="col-sm-12 col-md-6"><h2 class="doc">Heading 2<small class="doc">Subheading</small></h2></div>
|
||||
<div class="col-sm-12 col-md-6 col-md-last"><h3 class="doc">Heading 3<small class="doc">Subheading</small></h3></div>
|
||||
<div class="col-sm-12 col-md-6 col-md-first"><h4 class="doc">Heading 4<small class="doc">Subheading</small></h4></div>
|
||||
<div class="col-sm-12 col-md-6"><h5 class="doc">Heading 5<small class="doc">Subheading</small></h5></div>
|
||||
<div class="col-sm-12 col-md-6 col-md-last"><h6 class="doc">Heading 6<small class="doc">Subheading</small></h6></div></div>`,
|
||||
samples: [
|
||||
`<pre><span class="code-line"><span class="highlight-a"><h1></span>Heading 1 <span class="highlight-a"><small></span>Subheading<span class="highlight-a"></small></h1></span></span>
|
||||
<span class="code-line"><span class="highlight-a"><h2></span>Heading 2 <span class="highlight-a"><small></span>Subheading<span class="highlight-a"></small></h2></span></span>
|
||||
<span class="code-line"><span class="highlight-a"><h3></span>Heading 3 <span class="highlight-a"><small></span>Subheading<span class="highlight-a"></small></h3></span></span>
|
||||
<span class="code-line"><span class="highlight-a"><h4></span>Heading 4 <span class="highlight-a"><small></span>Subheading<span class="highlight-a"></small></h4></span></span>
|
||||
<span class="code-line"><span class="highlight-a"><h5></span>Heading 5 <span class="highlight-a"><small></span>Subheading<span class="highlight-a"></small></h5></span></span>
|
||||
<span class="code-line"><span class="highlight-a"><h6></span>Heading 6 <span class="highlight-a"><small></span>Subheading<span class="highlight-a"></small></h6></span></span></pre>
|
||||
`
|
||||
],
|
||||
notes: [],
|
||||
customization: [
|
||||
`Text color can be changed globally by changing the value of the <code>--fore-color</code> variable. This will affect the color of the headings' main text.`,
|
||||
`Secondary text color can be changed globally by changing the value of the <code>--secondary-fore-color</code> variable. This will affect the color of subheadings.`,
|
||||
`Universal margin for elements can be changed globally by changing the value of the <code>--universal-margin</code> 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 <code>--heading-ratio</code> variable. Bear in mind that the value of this variable must be unitless to work properly.`
|
||||
],
|
||||
modifiers: [],
|
||||
dos: [],
|
||||
donts: []
|
||||
}
|
||||
20
docs/doc-fragments/images.js
Normal file
20
docs/doc-fragments/images.js
Normal file
@@ -0,0 +1,20 @@
|
||||
module.exports = {
|
||||
id: 'images-captions',
|
||||
title: 'Images & captions',
|
||||
keywords: [`img`, `image`, `responsive`, `responsiveness`, `caption`, `figure`, `figcaption`],
|
||||
description: `<p>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.</p>
|
||||
<p>If you want to add captions to images, you can use HTML5 figure elements, along with their related captions.</p>`,
|
||||
example: '<figure><img src="https://placehold.it/800x600" alt="placeholder"><figcaption class="doc">Image caption</figcaption></figure>',
|
||||
samples: [`<pre><span class="code-line"><span class="highlight-a"><img</span> <span class="highlight-b">src</span>=<span class="highlight-c">"image.png"</span> <span class="highlight-b">alt</span>=<span class="highlight-c">"Image description"</span><span class="highlight-a">/></span></span></pre>`,
|
||||
`<pre><span class="code-line"><span class="highlight-a"><figure></span></span>
|
||||
<span class="code-line"> <span class="highlight-a"><img</span> <span class="highlight-b">src</span>=<span class="highlight-c">"image.png"</span> <span class="highlight-b">alt</span>=<span class="highlight-c">"Image description"</span><span class="highlight-a">/></span></span>
|
||||
<span class="code-line"> <span class="highlight-a"><figcaption></span>Image caption<span class="highlight-a"></figcaption></span></span>
|
||||
<span class="code-line"><span class="highlight-a"></figure></span></span></pre>`],
|
||||
notes: [`While not mandatory, it is considered a good practice to always add a <code>alt</code> attribute to image elements on your web apps.`],
|
||||
customization: [
|
||||
`You can change the text color of <code><figcaption></code> elements by changing the value of the <code>--secondary-fore-color</code> variable.`
|
||||
],
|
||||
modifiers: [],
|
||||
dos: [],
|
||||
donts: []
|
||||
}
|
||||
28
docs/doc-fragments/lists.js
Normal file
28
docs/doc-fragments/lists.js
Normal file
@@ -0,0 +1,28 @@
|
||||
module.exports = {
|
||||
id: 'lists',
|
||||
title: 'Lists',
|
||||
keywords: [`list`, `ul`, `ol`, `li`],
|
||||
description: `<p>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.</p>`,
|
||||
example: `<ul class="doc"><li class="doc">Apple</li><li class="doc">Orange</li><li class="doc">Strawberry</li></ul><br/>
|
||||
<ol class="doc"><li class="doc">Wake up</li><li class="doc">Eat breakfast</li><li class="doc">Go to work</li></ol>`,
|
||||
samples: [`<pre><span class="code-line"><span class="highlight-a"><ul></span></span>
|
||||
<span class="code-line"> <span class="highlight-a"><li></span>Apple<span class="highlight-a"></li></span></span>
|
||||
<span class="code-line"> <span class="highlight-a"><li></span>Orange<span class="highlight-a"></li></span></span>
|
||||
<span class="code-line"> <span class="highlight-a"><li></span>Strawberry<span class="highlight-a"></li></span></span>
|
||||
<span class="code-line"><span class="highlight-a"></ul></span></span>
|
||||
<span class="code-line"><span class="highlight-a"><ol></span></span>
|
||||
<span class="code-line"> <span class="highlight-a"><li></span>Wake up<span class="highlight-a"></li></span></span>
|
||||
<span class="code-line"> <span class="highlight-a"><li></span>Eat breakfast<span class="highlight-a"></li></span></span>
|
||||
<span class="code-line"> <span class="highlight-a"><li></span>Go to work<span class="highlight-a"></li></span></span>
|
||||
<span class="code-line"><span class="highlight-a"></ol></span></span></pre>`],
|
||||
notes: [],
|
||||
customization: [
|
||||
`Text color can be changed globally by changing the value of the <code>--fore-color</code> variable.`,
|
||||
`Background color can be changed globally by changing the value of the <code>--back-color</code> variable.`,
|
||||
`Universal margin for elements can be changed globally by changing the value of the <code>--universal-margin</code> 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 <code>--universal-padding</code> variable.`
|
||||
],
|
||||
modifiers: [],
|
||||
dos: [],
|
||||
donts: []
|
||||
}
|
||||
Reference in New Issue
Block a user