From c40471ea6dba2f4f8aa5fccd984c484a54167fe9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexis=20Pi=C3=A9plu?= Date: Fri, 27 Jan 2017 14:56:12 -0500 Subject: [PATCH 1/3] Add verbose, files, namespace and script configuration documention --- docs/src/views/configuration.pug | 46 ++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/docs/src/views/configuration.pug b/docs/src/views/configuration.pug index b72eec7..bdcc87b 100644 --- a/docs/src/views/configuration.pug +++ b/docs/src/views/configuration.pug @@ -124,3 +124,49 @@ block content div.SG-config__row div.SG-config__label Example div.SG-config__value nucleus --norandom + + h3.SG-h3 Verbose level + p.SG-p The vebosity level of the console output. For silent output set 0, for debug mode set 3. + div.SG-config + div.SG-config__row + div.SG-config__label CLI flag + div.SG-config__value --verbose + div.SG-config__row + div.SG-config__label Config key + div.SG-config__value verbose + div.SG-config__row + div.SG-config__label Default value + div.SG-config__value 3 + div.SG-config__row + div.SG-config__label Example + div.SG-config__value nucleus --verbose 2 + + h3.SG-h3 Files to crawl + p.SG-p Path to your scss files that nucelus use for generating source + div.SG-config + div.SG-config__row + div.SG-config__label Config key + div.SG-config__value files + div.SG-config__row + div.SG-config__label Default value + div.SG-config__value ["*.scss", "**/*.scss"] + + h3.SG-h3 Javascript files includes + p.SG-p Have your javascipt, you need to specify the path (URI) to your Javascript file. You may also pass multiple paths as array. + div.SG-config + div.SG-config__row + div.SG-config__label Config key + div.SG-config__value script + div.SG-config__row + div.SG-config__label Default value + div.SG-config__value null + + h3.SG-h3 Css namespace + p.SG-p If you use a CSS namespace class around your style. It will appear on the parent node preview. + div.SG-config + div.SG-config__row + div.SG-config__label Config key + div.SG-config__value namespace + div.SG-config__row + div.SG-config__label Default value + div.SG-config__value page From 89a068851d5ce7b2a9af8dd3d1de24e86b8e7f81 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexis=20Pi=C3=A9plu?= Date: Fri, 27 Jan 2017 15:35:48 -0500 Subject: [PATCH 2/3] Add script annotation --- docs/src/views/common/menu.pug | 1 + docs/src/views/configuration.pug | 4 ++++ docs/src/views/script.pug | 34 ++++++++++++++++++++++++++++++++ 3 files changed, 39 insertions(+) create mode 100644 docs/src/views/script.pug diff --git a/docs/src/views/common/menu.pug b/docs/src/views/common/menu.pug index b389209..718db6b 100644 --- a/docs/src/views/common/menu.pug +++ b/docs/src/views/common/menu.pug @@ -9,6 +9,7 @@ nav.menu.SG-toc li: a.SG-a(href="annotation-reference.html") Annotation reference li: a.SG-a(href="substitutions-flags.html") Substitutions & Flags li: a.SG-a(href="modifiers.html") Modifiers + li: a.SG-a(href="script.html") Script li: a.SG-a(href="vendored-elements.html") Vendored elements li.SG-toc__category Meta diff --git a/docs/src/views/configuration.pug b/docs/src/views/configuration.pug index bdcc87b..db05d41 100644 --- a/docs/src/views/configuration.pug +++ b/docs/src/views/configuration.pug @@ -1,3 +1,7 @@ +//- + With contributions from: + - Alexis Piéplu (alexis.pieplu@savoirfairelinux.com) + extends layouts/doc-page block title diff --git a/docs/src/views/script.pug b/docs/src/views/script.pug new file mode 100644 index 0000000..bd0195b --- /dev/null +++ b/docs/src/views/script.pug @@ -0,0 +1,34 @@ +//- + With contributions from: + - Alexis Piéplu (alexis.pieplu@savoirfairelinux.com) + +extends layouts/doc-page + +block title + | Script + +block content + h1.SG-h1 Script + p.SG-p. + For javascript code linked of your component, use @script tag that will render it in a code block, just below the markup. + + code.code.language-nucleus(data-d-code-preview). + /** + * Header bar with logo, navigation, and tool icons at the top of the page. + * + * @structure Header + * @flag full-width + * @markup + *
+ * @{include:.SG-logo} + * @{include:.SG-nav-icons} + * @{include:.SG-nav} + *
+ * @script + * $('body').on('click','.SG-header',function(){ + * $(this).doSomething(); + * }); + */ + .SG-header{ + ... + } From 0b6048ac5f4f76f1fdce5edf7d16b14b451f5aa5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexis=20Pi=C3=A9plu?= Date: Fri, 27 Jan 2017 15:43:09 -0500 Subject: [PATCH 3/3] Fix typo --- docs/src/views/configuration.pug | 8 ++++---- docs/src/views/script.pug | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/src/views/configuration.pug b/docs/src/views/configuration.pug index db05d41..a5410d7 100644 --- a/docs/src/views/configuration.pug +++ b/docs/src/views/configuration.pug @@ -130,7 +130,7 @@ block content div.SG-config__value nucleus --norandom h3.SG-h3 Verbose level - p.SG-p The vebosity level of the console output. For silent output set 0, for debug mode set 3. + p.SG-p To defines the vebosity level of the console output. For silent output set 0, for debug mode set 3. div.SG-config div.SG-config__row div.SG-config__label CLI flag @@ -146,7 +146,7 @@ block content div.SG-config__value nucleus --verbose 2 h3.SG-h3 Files to crawl - p.SG-p Path to your scss files that nucelus use for generating source + p.SG-p Path to your scss files that nuceleus use for generating source div.SG-config div.SG-config__row div.SG-config__label Config key @@ -156,7 +156,7 @@ block content div.SG-config__value ["*.scss", "**/*.scss"] h3.SG-h3 Javascript files includes - p.SG-p Have your javascipt, you need to specify the path (URI) to your Javascript file. You may also pass multiple paths as array. + p.SG-p To add your javascipt, you need to specify the path (URI) to your Javascript file. You may also pass multiple paths as array. div.SG-config div.SG-config__row div.SG-config__label Config key @@ -166,7 +166,7 @@ block content div.SG-config__value null h3.SG-h3 Css namespace - p.SG-p If you use a CSS namespace class around your style. It will appear on the parent node preview. + p.SG-p If you use a CSS namespace class around your style, it will appear on the parent node preview. div.SG-config div.SG-config__row div.SG-config__label Config key diff --git a/docs/src/views/script.pug b/docs/src/views/script.pug index bd0195b..e9cd674 100644 --- a/docs/src/views/script.pug +++ b/docs/src/views/script.pug @@ -10,7 +10,7 @@ block title block content h1.SG-h1 Script p.SG-p. - For javascript code linked of your component, use @script tag that will render it in a code block, just below the markup. + For javascript code linked to your component, use @script tag that will render it in a code block, just below the markup. code.code.language-nucleus(data-d-code-preview). /**