From ae335f2f46598435f2d394d56ee3c4926b8d7c63 Mon Sep 17 00:00:00 2001 From: Nguyen Huu Kim Date: Sat, 31 Mar 2018 23:15:42 +0700 Subject: [PATCH] Fix github page --- .npmignore | 1 + README.md | 11 +- _config.yml | 2 + demo/index.html | 299 ++++++++++++++++++++++++++++++++++++++++++++++ index.html | 192 ----------------------------- webpack.config.js | 8 +- 6 files changed, 319 insertions(+), 194 deletions(-) create mode 100644 _config.yml create mode 100644 demo/index.html delete mode 100644 index.html diff --git a/.npmignore b/.npmignore index 752e626..5d464e6 100644 --- a/.npmignore +++ b/.npmignore @@ -1,4 +1,5 @@ index.html webpack.config.js +_config.yml npm-debug.log yarn-error.log diff --git a/README.md b/README.md index c2354aa..86270a9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # Simple Scrollspy -Simple scrollspy without jQuery, no dependencies and lightweight. Only 1.94Kb. +[Simple scrollspy](https://huukimit.github.io/simple-scrollspy) is lightweight javascript library without jQuery, no dependencies. Only 1.94Kb. +This is a [demo](https://huukimit.github.io/simple-scrollspy/demo). ## Install You can install by `npm` or download inject `simple-scrollspy.js` file into your HTML code: @@ -47,3 +48,11 @@ Or: | `menuActiveTarget` | String | `li > a` | Element will be added active class | | `sectionClass` | String | `.scrollspy` | Query selector to your sections | | `activeClass` | String | `active` | Active class name | + +## Helpful links +- [Documentation](https://huukimit.github.io/simple-scrollspy) +- [Example](https://huukimit.github.io/simple-scrollspy/demo) +- [See on NPM package](https://www.npmjs.com/package/simple-scrollspy) + +## Licence +[MIT](./LICENSE) diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..d83dac3 --- /dev/null +++ b/_config.yml @@ -0,0 +1,2 @@ +theme: jekyll-theme-cayman +baseurl: simple-scrollspy diff --git a/demo/index.html b/demo/index.html new file mode 100644 index 0000000..37666f9 --- /dev/null +++ b/demo/index.html @@ -0,0 +1,299 @@ + + + + + + + Simple Scrollspy + + + +
+ + Simple Scrollspy + +
+ +
+

Simple Scrollspy

+

+ Simple scrollspy without jQuery, no dependencies and lightweight. Only 1.94Kb.
+ This is a demo +

+
+
+
+

Install

+

+ You can install by npm or download inject simple-scrollspy.js file into your HTML code: +

+

+ + npm install simple-scrollspy + + + <script src="/path/to/dist/simple-scrollspy.js"></script> + +

+
+
+

Usages

+

+ 

+import scrollSpy from 'simple-scrollspy'
+
+scrollSpy('#menu-list', {
+    offset: 100,
+    menuActiveTarget: '.menu__item > a',
+    sectionClass: 'body section.scrollspy',
+    activeClass: 'active'
+})
+
+

+

+ 

+<script src="/path/to/dist/simple-scrollspy.js"></script>
+<script>
+    window.onload = function () {
+        scrollSpy('#menu-list', {
+            offset: 100,
+            menuActiveTarget: '.menu__item > a',
+            sectionClass: 'body section.scrollspy',
+            activeClass: 'active'
+        })
+    }
+</script>
+
+

+
+
+

Arguments

+

+

    +
  • + The first argument is your menu list selector. Type of String|HTMLElement. +
    • +
  • + The second argument is optional. Type of Object: +
    • +
+

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
offsetNumber0Offset number
menuActiveTargetStringli > aElement will be added active class
sectionClassString.scrollspyQuery selector to your sections
activeClassStringactiveActive class name
+
+
+
+

License

+

MIT License


+ +

Copyright (c) 2018 Kim Nguyen Huu


+ +

+ 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. +

+ + + Nguyen Huu Kim <kimnguyen.ict@gmail.com> + +
+
+ + + + + diff --git a/index.html b/index.html deleted file mode 100644 index d8f805b..0000000 --- a/index.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - - Simple Scrollspy - - - -
-
- -
-

Homepage

-

- Lorem ipsum dolor sit amet, consectetur adipisicing elit. Consequuntur id nulla recusandae vel! Autem - cupiditate dignissimos distinctio dolores error est ex fuga, fugit hic illo ipsa iusto laboriosam - molestias numquam quidem reiciendis reprehenderit sequi velit? Accusamus ad adipisci animi aspernatur - atque doloremque enim esse et ex explicabo harum labore modi natus necessitatibus odit, porro qui quos - rem saepe sequi, soluta veritatis voluptatem voluptatum. Deserunt eaque et, eveniet id itaque laborum - nemo quaerat quia quisquam quos rerum soluta tenetur, totam vero vitae. Delectus distinctio dolores, - ducimus eius eos, est expedita facere illo ipsa nobis officia quasi rerum sunt, tempore voluptas - voluptatem? -

-
-
-
-

Post

-

- Lorem ipsum dolor sit amet, consectetur adipisicing elit. Aliquid aspernatur atque dolore dolores explicabo - fuga fugiat id, impedit quo reiciendis? Deserunt dolorem ducimus esse hic magnam, pariatur similique - voluptatibus. Accusantium aut consequatur, debitis deleniti dicta dolore doloribus ducimus ea eius eos - exercitationem facere fugiat, impedit ipsa iste iusto laudantium maxime molestiae mollitia natus non officia - omnis optio possimus praesentium quaerat quidem quis, quisquam quod ratione saepe tempore totam voluptates? - Aliquam, blanditiis deserunt doloremque eligendi esse, eum facere laboriosam nobis sed sit velit voluptates? - Accusantium architecto asperiores atque consectetur delectus distinctio, doloribus ducimus enim error harum - ipsam ipsum iste iure laudantium minus officia optio perferendis qui quod repellendus rerum temporibus vel - voluptatum? Aliquam amet animi autem blanditiis ducimus eaque eligendi eos esse est eveniet facilis id illo - inventore itaque magnam maxime necessitatibus nesciunt possimus praesentium repudiandae, sint, soluta ullam - voluptatum. Aperiam architecto aspernatur beatae doloremque eveniet ex explicabo impedit incidunt - laboriosam, neque nostrum quaerat quia repellendus soluta sunt! A explicabo iste iusto, placeat quidem - tenetur. Architecto at doloribus esse fugit incidunt neque nesciunt nisi porro repellat sunt. Accusantium - aliquam amet assumenda blanditiis consequatur distinctio eligendi, exercitationem in ipsa nam necessitatibus - perspiciatis quibusdam quo reprehenderit sed sequi similique, suscipit vero voluptates voluptatibus. -

-
-
-

Blog

-

- Lorem ipsum dolor sit amet, consectetur adipisicing elit. Aliquid asperiores, culpa dolorem doloribus, est - impedit necessitatibus odit quia, quidem repellat saepe voluptate? A ad alias aliquam consequuntur - dignissimos dolorem ea eaque eius enim eveniet fugiat id illo in inventore ipsum libero magnam molestias - mollitia nihil numquam omnis optio quasi quis recusandae, repellendus totam vero vitae voluptas voluptatibus - voluptatum! A architecto asperiores consequuntur deleniti ducimus error inventore maiores nesciunt, nulla - obcaecati possimus qui rerum sit temporibus ullam, veniam voluptas. Adipisci architecto at commodi - consequuntur corporis delectus deleniti, dolorum eaque eius et eveniet explicabo facere fuga in iure laborum - magni maiores, minima minus molestias mollitia natus numquam obcaecati omnis placeat quam quis, ratione - reiciendis repellat saepe sequi similique sit totam voluptas voluptatem voluptatibus voluptatum? Aspernatur - cum obcaecati odio quasi quo temporibus. Consequatur delectus dolores facere fuga in ipsum iure labore - laborum libero minus modi nam optio porro possimus quasi quo tempora tempore, voluptatem? Accusamus - architecto, at aut autem beatae delectus dolor eum fugiat hic nam nihil obcaecati perspiciatis porro quam - quasi qui quibusdam recusandae soluta! Ad aliquid architecto assumenda at atque beatae delectus deserunt - dolor, eius et facere, fugiat incidunt iure magni nemo nobis numquam officia possimus quia reprehenderit - tempora tenetur voluptatibus. -

-
-
-

About me

-

- Lorem ipsum dolor sit amet, consectetur adipisicing elit. Accusantium alias aliquam aspernatur beatae - consectetur culpa deleniti eum, incidunt libero maxime natus odio placeat possimus quae sit, sunt tenetur! - Amet architecto cumque deleniti, dicta dolore doloribus enim ex expedita incidunt inventore, maiores - nesciunt pariatur quos reiciendis repudiandae velit voluptate. Cupiditate delectus dicta facere illum - impedit ipsum iure nihil rem. Ab accusantium aliquid aperiam architecto consequatur cumque delectus - dignissimos dolorem dolores ea, eaque eius et eum excepturi expedita hic illo laboriosam laborum molestiae - nemo nobis nulla placeat quidem quod sapiente sint soluta sunt tenetur totam unde veniam vitae voluptates - voluptatibus! Accusantium asperiores, commodi cupiditate dicta doloribus ea eveniet fugiat harum in odio - perspiciatis totam veniam vero! Nostrum quaerat vitae voluptas! Aperiam, delectus earum eius eos ex id - impedit, nihil nostrum optio perspiciatis porro quaerat qui repellendus repudiandae temporibus. Ad aliquam - cum dolores dolorum fugit, in incidunt, obcaecati officiis quam quasi quidem tempore veniam voluptatibus. - Accusantium commodi consequuntur dolor ea iure, modi natus nobis placeat provident repudiandae veniam - voluptatibus. Ad atque, cumque inventore labore minus pariatur tenetur ut? Ab at atque dolor dolore eaque - earum exercitationem hic, ipsam ipsum necessitatibus perspiciatis reiciendis vero voluptates. A ab beatae - dolore eveniet explicabo itaque nesciunt voluptas? -

-
-
- - - - - diff --git a/webpack.config.js b/webpack.config.js index fba7855..0d2dd4a 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -1,4 +1,5 @@ const {resolve} = require('path') +const UglifyJsPlugin = require('uglifyjs-webpack-plugin') module.exports = { entry: resolve(__dirname, 'src/index.js'), @@ -7,5 +8,10 @@ module.exports = { filename: 'simple-scrollspy.js', library: 'scrollSpy', libraryTarget: 'umd' - } + }, + plugins: [ + new UglifyJsPlugin({ + exclude: [/\.min\.js$/gi] // skip pre-minified libs + }) + ] }