feat(documentation): new documentation. this package replace @yeutech-lab/rollup-umd-documentation

Author: Dimitri Kopriwa

.npmignore

@@ -16,6 +16,7 @@ babel.ext.json
 /coverage
 /src
 /docs
+/jsdoc.md
 /public
 /bundle-stats.html
 /CODE_OF_CONDUCT.md

docs/getting-started.md renamed to CHANGELOG.md

@@ -68,7 +68,7 @@ members of the project's leadership.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
+available at http://contributor-covenant.org/version/1/4
 
 [homepage]: http://contributor-covenant.org
 [version]: http://contributor-covenant.org/version/1/4/

CODE_OF_CONDUCT.md

@@ -1 +1,7 @@
-(c) Copyright 2018 Yeutech Company Limited, all rights reserved.
+Copyright 2018 Yeutech Company Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

LICENSE.md

@@ -6,6 +6,7 @@ module.exports = merge({
     'src',
     'styleguide',
   ],
+  comments: false,
   presets: [
     [
       '@babel/preset-env',

babel.config.js

@@ -22,24 +22,6 @@ Build the `/lib` directory:
 $ npm run build:lib
 ```
 
-Build the `/dist` directory:
-
-```bash
-$ npm run build:dist
-```
-
-Build the `/dist` directory "uncompressed":
-
-```bash
-$ npm run build:dist:dev
-```
-
-Watch the `/dist` directory:
-
-```bash
-$ npm run build:dist:watch
-```
-
 Watch the `/lib` directory:
 
 ```bash
@@ -57,3 +39,9 @@ Build documentation in `/public` directory:
 ```bash
 $ npm run styleguide:build
 ```
+
+Build the jsdom documentation:
+
+```bash
+$ npm run jsdom
+```

declination.json

@@ -0,0 +1,53 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## 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].
+
+### 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 - 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.loadersConfigPath` **[string][5]** options.loadersConfigPath - Location of the loaders within the layout package (optional, default `lib/loaders`)
+    -   `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`)
+    -   `options.disableAutoConf` **[boolean][6]** option.disableAutoConf - Disable auto configuration of layout package (optional, default `false`)
+
+### Examples
+
+```js static
+// Choose manually a layout package and expand example by default
+const { createConfig } = require('$PACKAGE_NAME');
+const styleguideConfig = { exampleMode: 'expand' };
+const options = { layout: '@bootstrap-styled/documentation' };
+const config = createConfig(styleguideConfig, options);
+// this is a working and compatible react-styleguidist configuration
+module.exports = config;
+```
+
+Returns **[Object][3]** react-styleguidist [configuration][4] configuration object
+
+[1]: https://react-styleguidist.js.org
+
+[2]: #layout-package-create
+
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[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

docs/commands.md

@@ -0,0 +1,8 @@
+This is an incomplete list of awesome things built for $PACKAGE_NAME. 
+
+If you have something to share, please add it to the $PACKAGE_NAME repo on GitHub and it will automatically show up here!
+
+## Built for $PACKAGE_NAME
+
+- [@bootstrap-styled/rsg-components](https://bootstrap-styled.github.io/rsg-components/): Reusable react components for creating layouts
+- [@rollup-umd/documentation-cli](https://rollup-umd.github.io/documentation-cli/): CLI utils for $PACKAGE_NAME