From 80cccd986ae912230132c8e4c96f5c707b7cf333 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dennis=20Heibu=CC=88lt?= Date: Thu, 22 Feb 2018 16:11:35 +0100 Subject: [PATCH] [refs #3] Add `requirement` flag MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. --- _docs/elements/headings.md | 1 + _docs/elements/images.md | 1 + _docs/elements/page.md | 1 + _docs/elements/tables.md | 1 + _docs/generic/box-sizing.md | 1 + _docs/generic/normalize.md | 1 + _docs/generic/reset.md | 1 + _docs/generic/shared.md | 1 + _docs/objects/block.md | 1 + _docs/objects/box.md | 1 + _docs/objects/crop.md | 1 + _docs/objects/flag.md | 1 + _docs/objects/layout.md | 1 + _docs/objects/list-bare.md | 1 + _docs/objects/list-inline.md | 1 + _docs/objects/media.md | 1 + _docs/objects/pack.md | 1 + _docs/objects/ratio.md | 1 + _docs/objects/tables.md | 1 + _docs/objects/wrapper.md | 1 + _docs/settings/core.md | 1 + _docs/tools/clearfix.md | 1 + _docs/tools/font-size.md | 1 + _docs/tools/hidden.md | 1 + _docs/utilities/clearfix.md | 1 + _docs/utilities/headings.md | 1 + _docs/utilities/hide.md | 1 + _docs/utilities/print.md | 1 + _docs/utilities/spacing.md | 1 + _docs/utilities/widths.md | 1 + 30 files changed, 30 insertions(+) diff --git a/_docs/elements/headings.md b/_docs/elements/headings.md index 51c90b2..bf91952 100644 --- 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 index 85a4f62..0a22b68 100644 --- 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 index 384b064..3b5b18e 100644 --- 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 index 5e26d2b..deaaa90 100644 --- 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 index 7514385..1de6a1e 100644 --- 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 index cd7ab25..cd0a0f0 100644 --- 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 index c565162..9441ccc 100644 --- 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 index 24de1da..b94e2e5 100644 --- 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 index 1cd8240..e538e96 100644 --- 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 index 582cba4..d348a2c 100644 --- 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 index c698bd6..ed89eae 100644 --- 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 index e13128d..e03328c 100644 --- 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 index 8dd36e4..feabd6f 100644 --- 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 index d072777..9762aa0 100644 --- 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 index bc8da16..ad1ae77 100644 --- 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 index 9b3a122..5a99c13 100644 --- 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 index 1880ad3..20e8a97 100644 --- 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 index 08679ca..3021980 100644 --- 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 index 26dd9b7..afcef35 100644 --- 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 index 0dcc804..0243433 100644 --- 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 index 1bc85c5..9f5f6d9 100644 --- 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 index 8ca3393..5737e29 100644 --- 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 index 3c0e189..cee9c62 100644 --- 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 index 6452098..022df4d 100644 --- 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 index ee23ba3..c3b0286 100644 --- 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 index 58064ad..b35324d 100644 --- 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 index 0cafe5a..5727598 100644 --- 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 index 5eedb48..a6ca6f9 100644 --- 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 index d515719..84f30a3 100644 --- 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 index c761571..d8a7c3d 100644 --- 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" ---