Infra/unify docs (#1036)

* Fix docs

* change docs:build script

* Fix docs:build script

* dont include docs building in CI build due to issues

* prepare a uilib-docs package

* remove private field from package.json

* exclude public folder in npmignore

* Change imports to require

* export markdown plugin as a function to inject a path

* use relative path for layout plugin

* filter invalid markdown pages

* update version

* Update uilib-docs/.npmignore

Co-authored-by: Miki <[email protected]>

Co-authored-by: Miki <[email protected]>

Author: ethanshar

uilib-docs/.npmignore

@@ -0,0 +1,5 @@
+node_modules/
+.npmignore
+
+.cache
+public

uilib-docs/configurations/pageCreators/createMarkdownPages.js

@@ -4,7 +4,7 @@ module.exports = async ({graphql, boundActionCreators}) => {
   const {createPage} = boundActionCreators;
   const result = await graphql(`
     {
-      allFile(filter: {sourceInstanceName: {eq: "markdown-pages"}}) {
+      allFile(filter: {sourceInstanceName: {eq: "markdown-pages"}, childMarkdownRemark: {frontmatter: {path: {ne: null}}}}) {
         edges {
           node {
             id
@@ -24,11 +24,13 @@ module.exports = async ({graphql, boundActionCreators}) => {
   `);
 
   result.data.allFile.edges.forEach(({node}) => {
-    createPage({
-      name: node.name,
-      path: node.childMarkdownRemark.frontmatter.path,
-      component: path.resolve(`src/templates/markdownTemplate.js`),
-      context: {} // additional data can be passed via context
-    });
+    if (node.childMarkdownRemark.frontmatter.path) {
+      createPage({
+        name: node.name,
+        path: node.childMarkdownRemark.frontmatter.path,
+        component: path.resolve(`src/templates/markdownTemplate.js`),
+        context: {} // additional data can be passed via context
+      });
+    }
   });
 };

uilib-docs/configurations/plugins.js

@@ -1,3 +1,5 @@
+const path = require('path');
+
 const manifestPlugin = [
   {
     resolve: `gatsby-plugin-manifest`,
@@ -13,12 +15,12 @@ const manifestPlugin = [
   }
 ];
 
-const markdownPagesPlugin = [
+const markdownPagesPlugin = (path = `${__dirname}/../../markdowns/`) => [
   {
     resolve: `gatsby-source-filesystem`,
     options: {
       name: `markdown-pages`,
-      path: `${__dirname}/../../markdowns/`
+      path
     }
   },
   `gatsby-transformer-remark`
@@ -73,7 +75,7 @@ const layoutPlugin = [
   {
     resolve: `gatsby-plugin-layout`,
     options: {
-      component: require.resolve(`${__dirname}/../src/components/layout.js`)
+      component: require.resolve(`${path.resolve('./')}/src/components/layout.js`)
     }
   }
 ];

uilib-docs/gatsby-config.js

@@ -10,7 +10,7 @@ module.exports = {
   plugins: [
     `gatsby-plugin-react-helmet`,
     `gatsby-plugin-sass`,
-    ...markdownPagesPlugin,
+    ...markdownPagesPlugin(),
     ...componentsDocgenPlugin,
     ...incubatorComponentsDocgenPlugin,
     ...nativeComponentsDocgenPlugin,

uilib-docs/index.js

@@ -0,0 +1,7 @@
+const PageCreators = require('./configurations/pageCreators');
+const Plugins = require('./configurations/plugins');
+
+module.exports = {
+  PageCreators,
+  Plugins
+};

uilib-docs/package.json

@@ -1,9 +1,9 @@
 {
-  "name": "gatsby-starter-default",
-  "private": true,
-  "description": "A simple starter to get up and developing quickly with Gatsby",
-  "version": "0.1.0",
-  "author": "Kyle Mathews <[email protected]>",
+  "name": "uilib-docs",
+  "description": "uilib docs template",
+  "version": "1.0.4",
+  "author": "Ethan Sharabi <[email protected]>",
+  "main": "index.js",
   "dependencies": {
     "classnames": "^2.2.6",
     "gatsby": "^2.0.0",

uilib-docs/src/components/navbar/index.js

@@ -125,7 +125,7 @@ class Navbar extends Component {
                 }
               }
             }
-            allFile(filter: {sourceInstanceName: {eq: "markdown-pages"}}) {
+            allFile(filter: {sourceInstanceName: {eq: "markdown-pages"}, childMarkdownRemark: {frontmatter: {path: {ne: null}}}}) {
               edges {
                 node {
                   childMarkdownRemark {