feat: added ui/pages packages with pre-built page templates

ccontrols · Apr 23, 2020 · 71b3b80 · 71b3b80
1 parent 2504568
commit 71b3b80
Show file tree

Hide file tree

Showing 32 changed files with 309 additions and 35,725 deletions.
diff --git a/README.md b/README.md
@@ -16,9 +16,10 @@
     -   [@component-controls/webpack-configs](#component-controlswebpack-configs)
     -   [@component-controls/store](#component-controlsstore)
 -   [UI packages](#ui-packages)
+    -   [@component-controls/pages](#component-controlspages)
+    -   [@component-controls/blocks](#component-controlsblocks)
     -   [@component-controls/components](#component-controlscomponents)
     -   [@component-controls/editors](#component-controlseditors)
-    -   [@component-controls/blocks](#component-controlsblocks)
 -   [Props info](#props-info)
     -   [@component-controls/react-docgen-info](#component-controlsreact-docgen-info)
     -   [@component-controls/react-docgen-typescript-info](#component-controlsreact-docgen-typescript-info)
@@ -196,6 +197,40 @@ Utility class to abstract loading the stories store from the webpack loader and
 
 The UI libraries are built around [theme-ui](https://theme-ui.com) and are designed to abstract the user interface level of components.
 
+<package-section file="./ui/pages/README.md" section="overview" />
+
+<!-- START-PACKAGE-SECTION -->
+
+## [@component-controls/pages](https://github.com/ccontrols/component-controls/blob/master/ui/pages)
+
+Component controls pre-built documentation page templates.
+
+A collection of pre-built documentation page templates.
+
+-   The only requirement is that the pages are wrapped in a `<BlockContext />` react context.
+-   The templates can be used in any environment (storybook, standalone, gatsby)
+
+<!-- END-PACKAGE-SECTION -->
+
+<package-section file="./ui/blocks/README.md" section="overview" />
+
+<!-- START-PACKAGE-SECTION -->
+
+## [@component-controls/blocks](https://github.com/ccontrols/component-controls/blob/master/ui/blocks)
+
+Component controls core documentation blocks.
+
+Some of the guiding design goals for this library:
+
+-   Most components should have a 'plain' and a 'block' version, where the block version adds a collapsible Box with a title.
+-   There are two main categories of components: 
+    -   that display story data (i.e. story source, story render)
+    -   that display component(s) data (i.e. prop tables, component sources)
+-   Components accept a list of custom ActionItems to be extended. 
+-   Compnents that deal with source code (story or component source) display actions to browse their respective repositories.
+
+<!-- END-PACKAGE-SECTION -->
+
 <package-section file="./ui/components/README.md" section="overview" />
 
 <!-- START-PACKAGE-SECTION -->
@@ -239,25 +274,6 @@ Some of the guiding design goals for this library:
 
 <!-- END-PACKAGE-SECTION -->
 
-<package-section file="./ui/blocks/README.md" section="overview" />
-
-<!-- START-PACKAGE-SECTION -->
-
-## [@component-controls/blocks](https://github.com/ccontrols/component-controls/blob/master/ui/blocks)
-
-Component controls core documentation blocks.
-
-Some of the guiding design goals for this library:
-
--   Most components should have a 'plain' and a 'block' version, where the block version adds a collapsible Box with a title.
--   There are two main categories of components: 
-    -   that display story data (i.e. story source, story render)
-    -   that display component(s) data (i.e. prop tables, component sources)
--   Components accept a list of custom ActionItems to be extended. 
--   Compnents that deal with source code (story or component source) display actions to browse their respective repositories.
-
-<!-- END-PACKAGE-SECTION -->
-
 # Props info
 
 The props-info packages are designed to solidify prop tables extraction for components. Every props-info package must export a props extractor factory that is initialized with the options for the specific library and returns a function that can parse a file and extract prop tables.

diff --git a/examples/storybook-6-no-docs/.storybook/main.js b/examples/storybook-6-no-docs/.storybook/main.js
@@ -4,8 +4,7 @@ module.exports = {
   addons: [{
     name: '@component-controls/storybook',
     options: {
-      webpack: [
-        'instrument','react-docgen-typescript'],
+      webpack: ['instrument','react-docgen-typescript'],
     }
   }],    
   stories: [

diff --git a/examples/storybook-6/docs/favicon.ico b/examples/storybook-6/docs/favicon.ico
diff --git a/examples/storybook-6/docs/index.html b/examples/storybook-6/docs/index.html
diff --git a/examples/storybook-6/docs/main.960b291f16add2c8672b.bundle.js b/examples/storybook-6/docs/main.960b291f16add2c8672b.bundle.js
diff --git a/examples/storybook-6/docs/runtime~main.ab7db0239d02e2e25577.bundle.js b/examples/storybook-6/docs/runtime~main.ab7db0239d02e2e25577.bundle.js
diff --git a/examples/storybook-6/docs/sb_dll/storybook_docs-manifest.json b/examples/storybook-6/docs/sb_dll/storybook_docs-manifest.json