[refs #3] Add requirement flag

Showing the user what partial is required, what is recommended and what is ‘just’ optional in the docs would be useful when deciding of which partial to include and which not.
inuitcss · Feb 22, 2018 · 80cccd9 · 80cccd9
1 parent 85596f5
commit 80cccd9
Show file tree

Hide file tree

Showing 30 changed files with 30 additions and 0 deletions.
diff --git a/_docs/elements/headings.md b/_docs/elements/headings.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_elements.headings.scss"
+requirement: optional
 ---
 
 {% include file-info.html %}

diff --git a/_docs/elements/images.md b/_docs/elements/images.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_elements.images.scss"
+requirement: optional
 ---
 
 {% include file-info.html %}

diff --git a/_docs/elements/page.md b/_docs/elements/page.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_elements.page.scss"
+requirement: recommended
 ---
 
 {% include file-info.html %}

diff --git a/_docs/elements/tables.md b/_docs/elements/tables.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_elements.tables.scss"
+requirement: optional
 ---
 
 {% include file-info.html %}

diff --git a/_docs/generic/box-sizing.md b/_docs/generic/box-sizing.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_generic.box-sizing.scss"
+requirement: required
 ---
 
 {% include file-info.html %}

diff --git a/_docs/generic/normalize.md b/_docs/generic/normalize.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_generic.normalize.scss"
+requirement: recommended
 ---
 
 {% include file-info.html %}

diff --git a/_docs/generic/reset.md b/_docs/generic/reset.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_generic.reset.scss"
+requirement: recommended
 ---
 
 {% include file-info.html %}

diff --git a/_docs/generic/shared.md b/_docs/generic/shared.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_generic.shared.scss"
+requirement: recommended
 ---
 
 {% include file-info.html %}

diff --git a/_docs/objects/block.md b/_docs/objects/block.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_objects.block.scss"
+requirement: optional
 demo: "block"
 classes: [
     "o-block",

diff --git a/_docs/objects/box.md b/_docs/objects/box.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_objects.box.scss"
+requirement: optional
 demo: "box"
 classes: [
     "o-box",

diff --git a/_docs/objects/crop.md b/_docs/objects/crop.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_objects.crop.scss"
+requirement: optional
 demo: "crop"
 classes: [
     "o-crop",

diff --git a/_docs/objects/flag.md b/_docs/objects/flag.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_objects.flag.scss"
+requirement: optional
 demo: "flag"
 classes: [
     "o-flag",

diff --git a/_docs/objects/layout.md b/_docs/objects/layout.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_objects.layout.scss"
+requirement: optional
 demo: "layout"
 classes: [
     "o-layout",

diff --git a/_docs/objects/list-bare.md b/_docs/objects/list-bare.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_objects.list-bare.scss"
+requirement: optional
 demo: "list-bare"
 classes: [
     "o-list-bare"

diff --git a/_docs/objects/list-inline.md b/_docs/objects/list-inline.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_objects.list-inline.scss"
+requirement: optional
 demo: "list-inline"
 classes: [
     "o-list-inline",

diff --git a/_docs/objects/media.md b/_docs/objects/media.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_objects.media.scss"
+requirement: optional
 demo: "media"
 classes: [
     "o-media",

diff --git a/_docs/objects/pack.md b/_docs/objects/pack.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_objects.pack.scss"
+requirement: optional
 demo: "pack"
 classes: [
     "o-pack",

diff --git a/_docs/objects/ratio.md b/_docs/objects/ratio.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_objects.ratio.scss"
+requirement: optional
 demo: "ratio"
 classes: [
     "o-ratio",

diff --git a/_docs/objects/tables.md b/_docs/objects/tables.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_objects.tables.scss"
+requirement: optional
 demo: "tables"
 classes: [
     "o-table",

diff --git a/_docs/objects/wrapper.md b/_docs/objects/wrapper.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_objects.wrapper.scss"
+requirement: optional
 demo: "wrapper"
 classes: [
     "o-wrapper",

diff --git a/_docs/settings/core.md b/_docs/settings/core.md
@@ -7,6 +7,7 @@ has-sub-content: true
 sub-content: docs
 filename: "_settings.core.scss"
 permalink: /docs/settings/core/
+requirement: required
 ---
 
 {% include file-info.html %}

diff --git a/_docs/tools/clearfix.md b/_docs/tools/clearfix.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_tools.clearfix.scss"
+requirement: required
 ---
 
 {% include file-info.html %}

diff --git a/_docs/tools/font-size.md b/_docs/tools/font-size.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_tools.font-size.scss"
+requirement: required
 ---
 
 {% include file-info.html %}

diff --git a/_docs/tools/hidden.md b/_docs/tools/hidden.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_tools.hidden.scss"
+requirement: required
 ---
 
 {% include file-info.html %}

diff --git a/_docs/utilities/clearfix.md b/_docs/utilities/clearfix.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_utilities.clearfix.scss"
+requirement: optional
 demo: "clearfix"
 ---
 

diff --git a/_docs/utilities/headings.md b/_docs/utilities/headings.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_utilities.headings.scss"
+requirement: optional
 demo: "headings"
 ---
 

diff --git a/_docs/utilities/hide.md b/_docs/utilities/hide.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_utilities.hide.scss"
+requirement: optional
 demo: "hide"
 ---
 

diff --git a/_docs/utilities/print.md b/_docs/utilities/print.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_utilities.print.scss"
+requirement: optional
 ---
 
 {% include file-info.html %}
diff --git a/_docs/utilities/spacing.md b/_docs/utilities/spacing.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_utilities.spacing.scss"
+requirement: optional
 demo: "spacing"
 ---
 

diff --git a/_docs/utilities/widths.md b/_docs/utilities/widths.md
@@ -6,6 +6,7 @@ page-class: c-page--docs
 has-sub-content: true
 sub-content: docs
 filename: "_utilities.widths.scss"
+requirement: optional
 demo: "widths"
 ---