Merge pull request #7 from rollup-umd/dev

kopax · web-flow · commit 5b6d67a69a4b · 2018-12-05T19:35:10.000+07:00
Dev
diff --git a/.travis.yml b/.travis.yml
@@ -57,7 +57,7 @@ jobs:
 
     # Job: Release
     - stage: release
-      if: branch = master
+      if: branch = master AND type = push AND fork = false
       node_js:
         - 'lts/*'
       skip_cleanup: true
@@ -66,7 +66,7 @@ jobs:
 
     # Job: Page
     - stage: deploy
-      if: branch = master
+      if: branch = master AND type = push AND fork = false
       node_js:
         - 'lts/*'
       script:
diff --git a/docs/configuration/create-config.md b/docs/configuration/create-config.md
diff --git a/docs/getting-started/configuration/create-config.md b/docs/getting-started/configuration/create-config.md
@@ -2,31 +2,34 @@
 
 ## createConfig
 
-You need to import `createConfig`  into your [react-styleguidist][1] configuration file (generally `styleguide.config.js`).
-All options are optional, and can be autoconfigured by installing a [layout package][2].
+You need to import `createConfig` into your styleguidist configuration file (generally `styleguide.config.js`).
+All options are optional, and can be autoconfigured by installing a [layout package][1].
 
 ### Parameters
 
--   `config` **[Object][3]** for react-styleguidist user configuration, it will be used to override our default styleguide configuration. See [https://react-styleguidist.js.org/docs/configuration.html][4] (optional, default `{}`)
--   `options` **[Object][3]** for $PACKAGE_NAME features (optional, default `{}`)
-    -   `options.layout` **[string][5]** options.layout - Name of the layout package (optional, default `''`)
-    -   `options.layoutPath` **[string][5]** options.layoutPath - Location of the Layout component within the layout package (optional, default `lib/Layout`)
-    -   `options.wrapperPath` **[string][5]** options.wrapperPath [options.wrapperPath=lib/Wrapper] - Location of the Wrapper component within the layout package (optional, default `lib/Wrapper`)
-    -   `options.selectionConfigPath` **[string][5]** options.selectionConfigPath - Location of the styleguide.config.js within the layout package (optional, default `lib/styleguide.config.js`)
-    -   `options.styleGuideDirPath` **[string][5]** options.styleGuideDirPath - Location of the styleguide configuration directory within your project (optional, default `styleguide`)
-    -   `options.extensionFile` **[string][5]** options.extensionFile - Name of the styleguide configuration extension within your project (optional, default `styleguide.ext.json`)
-    -   `options.setupFile` **[string][5]** options.setupFile - Name of the setup file within your project (optional, default `setup.js`)
-    -   `options.licensePath` **[string][5]** options.licensePath - Location of the license within your project (optional, default `LICENSE.md`)
-    -   `options.locale` **[string][5]** options.locale - Locale used for the documentation (optional, default `en`)
-    -   `options.loader` **[string][5]** options.loader - Loader to be used for the documentation (optional, default `wave`)
-    -   `options.loaders` **[Object][3]** options.loaders - object available for use (if layout package is installed, they will be automatically added during autoconfiguration) (optional, default `{wave:'<!-- content of wave loader >'}`)
-    -   `options.loaderInnerApp` **[boolean][6]** options.loaderInnerApp - If set to false, the loader will be injected in the main html outside of the react application context (optional, default `true`)
-    -   `options.favicon` **[string][5]** options.favicon - Favicon href url (optional, default `null`)
-    -   `options.head` **[string][5]** options.head - This will be injected at the end of <head /> tag (optional, default `null`)
+-   `config` **[Object][2]** for react-styleguidist user configuration, it will be used to override our default styleguide configuration. (optional, default `{}`)
+-   `options` **[Object][2]** for $PACKAGE_NAME features (optional, default `{}`)
+    -   `options.layout` **[string][3]** options.layout - Name of the layout package (optional, default `null`)
+    -   `options.layoutPath` **[string][3]** options.layoutPath - Location of the Layout component within the layout package (optional, default `lib/Layout`)
+    -   `options.wrapperPath` **[string][3]** options.wrapperPath - Location of the Wrapper component within the layout package (optional, default `lib/Wrapper`)
+    -   `options.styleguideConfigPath` **[string][3]** options.styleguideConfigPath - Location of the styleguide.config.js within the layout package (optional, default `lib/styleguide.config.js`)
+    -   `options.loadersConfigPath` **[string][3]** options.loadersConfigPath - Location of the loaders within the layout package (optional, default `lib/loaders`)
+    -   `options.styleGuideDirPath` **[string][3]** options.styleGuideDirPath - Location of the styleguide configuration directory within your project (optional, default `styleguide`)
+    -   `options.extensionFile` **[string][3]** options.extensionFile - Name of the styleguide configuration extension within your project (optional, default `styleguide.ext.json`)
+    -   `options.setupFile` **[string][3]** options.setupFile - Name of the setup file within your project (optional, default `setup.js`)
+    -   `options.licensePath` **[string][3]** options.licensePath - Location of the license within your project (optional, default `LICENSE.md`)
+    -   `options.locale` **[string][3]** options.locale - Locale used for the documentation (optional, default `en`)
+    -   `options.loader` **[string][3]** options.loader - Loader to be used for the documentation (optional, default `wave`)
+    -   `options.loaders` **[Object][2]** options.loaders - object available for use (if layout package is installed, they will be automatically added during autoconfiguration) (optional, default `{wave:'<!-- content of wave loader >'}`)
+    -   `options.loaderInnerApp` **[boolean][4]** options.loaderInnerApp - If set to false, the loader will be injected in the main html outside of the react application context (optional, default `true`)
+    -   `options.favicon` **[string][3]** options.favicon - favicon name (optional, default `null`)
+    -   `options.favicons` **[string][3]** options.favicons - Object with favicon name and href value for favicon (optional, default `{}`)
+    -   `options.head` **[string][3]** options.head - This will be injected at the end of <head /> tag (optional, default `null`)
+    -   `options.disableAutoConf` **[boolean][4]** option.disableAutoConf - Disable auto configuration of layout package (optional, default `false`)
 
 ### Examples
 
-```js static
+```javascript
 // Choose manually a layout package and expand example by default
 const { createConfig } = require('$PACKAGE_NAME');
 const styleguideConfig = { exampleMode: 'expand' };
@@ -36,16 +39,12 @@ const config = createConfig(styleguideConfig, options);
 module.exports = config;
 ```
 
-Returns **[Object][3]** react-styleguidist [configuration][4] configuration object
+Returns **[Object][2]** react-styleguidist configuration
 
-[1]: https://react-styleguidist.js.org
+[1]: #layout-package-create
 
-[2]: #layout-package-create
+[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
 
-[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
-[4]: https://react-styleguidist.js.org/docs/configuration.html
-
-[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
-
-[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
diff --git a/docs/getting-started/documenting/jsdoc.md b/docs/getting-started/documenting/jsdoc.md
@@ -1,4 +1,4 @@
-We use JSdoc annotations for annotating javascript and generating our markdown doc.
+We use JSdoc annotations in our javascript to generate documentation in markdown.
 
 If you don't know what JSdoc is, you should read their website:
 
diff --git a/docs/installation.md b/docs/installation.md
@@ -9,7 +9,7 @@ Or use `--save` if you are within a [layout package](#layout-package) you have c
 ### 2. Create `styleguide.config.js` in root of your project.
 
 ```js static
-const { createConfig } = require('$PACKAGE_NAME/lib/styleguide.config.js');
+const { createConfig } = require('$PACKAGE_NAME');
 
 module.exports = createConfig();
 
diff --git a/docs/layout-package/layout-package-create.md b/docs/layout-package/layout-package-create.md
@@ -67,3 +67,60 @@ export default makeTheme;
 If you don't know what is a `makeTheme` or a `theme`, you should read [Bootstrap Styled documentation](https://bootstrap-styled.github.com/bootstrap-styled).
 
 If you don't know how theme work, please read the [theme](#layout-theme) section of this documentation.
+
+Generally, if all you want is updating the theme, you will need to create a `Layout` in your layout package as follow:
+
+
+```js static
+import React, { Component } from 'react';
+import PropTypes from 'prop-types';
+import StyleGuideRenderer from '@rollup-umd/documentation/lib/Layout';
+import theme from '../theme';
+
+export default class LayoutRenderer extends Component { // eslint-disable-line react/prefer-stateless-function
+  static defaultProps = {
+    theme, // <--- this is where you hook your theme, this way, even your own LayoutRenderer can be extended and used another theme
+    ga: process.env.GA_ID,
+    logoMenu: {
+      logo: null,
+      href: null,
+      alt: 'Example of layout renderer',
+    },
+    logoFooter: {
+      logo: null,
+      href: null,
+      alt: 'Example of layout renderer',
+    },
+  };
+
+  static propTypes = {
+    /** Our edited theme */
+    theme: PropTypes.object,
+    /** Google analytics configuration */
+    ga: PropTypes.shape({
+      /** Google analytics id */
+      id: PropTypes.string,
+    }),
+    /** Logo to use in sidebar menu */
+    logoMenu: PropTypes.shape({
+      logo: PropTypes.node,
+      href: PropTypes.string,
+      alt: PropTypes.string,
+    }),
+    /** Logo to use in footer */
+    logoFooter: PropTypes.shape({
+      logo: PropTypes.node,
+      href: PropTypes.string,
+      alt: PropTypes.string,
+    }),
+  };
+
+  render() {
+    const { ...rest } = this.props;
+    return (
+      <StyleGuideRenderer {...rest} />
+    );
+  }
+}
+
+```
diff --git a/docs/layout-package/layout-package.md b/docs/layout-package/layout-package.md
@@ -1,12 +1,16 @@
-Layout package are useful when you want to maintain a documentation (layout/configuration) across multiple projects.
+Layout package are useful when you want to maintain a documentation layout and/or configuration across multiple projects.
 
-It's easy because all you need to is upgrade the version in `package.json` to get the latest update.
+It's convenient because it just need to be installed and does not require any code change.
+
+Updating can be done by upgrading the version of your layout package in `package.json`.
 
 It can contains customs:
 
 - `Layout`: the documentation layout
 - `Wrapper`: the wrapper for examples
-- `styleguide.config.js`: styleGuide configuration (will be merged into ours)
+- `styleguide.config.js`: styleGuide configuration (will be merged into our configuration)
 - `loaders`: Loaders injected by the package
-- `theme`: The `theme` and `makeTheme` respecting the Bootstrap Styled chart. 
+- `theme`: The `theme` and `makeTheme` respecting the Bootstrap Styled chart. It can be used in `Layout` using `props.theme`.
+
+None of them is required,  
 
diff --git a/styleguide/jsdoc.sh b/styleguide/jsdoc.sh
@@ -1,3 +1,3 @@
 #!/usr/bin/env bash
 
-npm run jsdoc-documentation src docs/configuration/create-config.md
+npm run jsdoc-documentation src/createConfig.js docs/getting-started/configuration/create-config.md
diff --git a/styleguide/styleguide.ext.json b/styleguide/styleguide.ext.json
@@ -136,7 +136,7 @@
     }
   ],
   "ribbon": {
-    "url": "",
+    "url": "https://github.com/rollup-umd/documentation",
     "text": "Fork us on GitHub"
   }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-We use JSdoc annotations for annotating javascript and generating our markdown doc.`
	`1`	`+We use JSdoc annotations in our javascript to generate documentation in markdown.`
`2`	`2`
`3`	`3`	`If you don't know what JSdoc is, you should read their website:`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`#!/usr/bin/env bash`
`2`	`2`
`3`		`-npm run jsdoc-documentation src docs/configuration/create-config.md`
	`3`	`+npm run jsdoc-documentation src/createConfig.js docs/getting-started/configuration/create-config.md`
Original file line number	Diff line number	Diff line change
`@@ -136,7 +136,7 @@`
`136`	`136`	`}`
`137`	`137`	`],`
`138`	`138`	`"ribbon": {`
`139`		`- "url": "",`
	`139`	`+ "url": "https://github.com/rollup-umd/documentation",`
`140`	`140`	`"text": "Fork us on GitHub"`
`141`	`141`	`}`
`142`		`-}`
	`142`	`+}`