-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathparams.json
6 lines (6 loc) · 1.43 KB
/
params.json
1
2
3
4
5
6
{
"name": "Smoothscrolljs",
"tagline": "Smooth Scroll for all internal links. ",
"body": "All internal links would scroll Smoothly.\r\n\r\nUsage : \r\n\r\nInclude the js file\r\n```\r\n<script type=\"text/javascript\" src=\"smoothScroll.js\"></script>\r\n```\r\n\r\nAdd this script after the body load. Ideally one may add this just before the closing of body tag.\r\n\r\n``` \r\n<script type=\"text/javascript\">\r\n smooth_scroll.init();\r\n</script>\r\n```\r\n\r\nIf there is a fixed header, pass the id of fixed header as config.\r\n\r\n```\r\n<script type=\"text/javascript\">\r\n smooth_scroll.init({\r\n header_id : \"page-header\"\r\n });\r\n</script>\r\n\r\n\r\n```\r\n\r\nIf there are links that should be ignored. Pass an array to ignore those links. Example\r\n\r\n```\r\n<script type=\"text/javascript\">\r\n smooth_scroll.init({\r\n header_id : \"page-header\",\r\n ignore_links: [\"page-header\"]\r\n });\r\n</script>\r\n\r\n\r\n```\r\n\r\nWithout Smooth Scroll\r\n![alt text](https://raw.githubusercontent.com/CodingNinjasCodes/SmoothScrollJs/master/without_smooth_scroll.gif \"Without Smooth Scroll\")\r\n\r\nWith Smooth Scroll\r\n![alt text](https://raw.githubusercontent.com/CodingNinjasCodes/SmoothScrollJs/master/with_smooth_scroll.gif \"With Smooth Scroll\")\r\n\r\n\r\n",
"note": "Don't delete this file! It's used internally to help with page regeneration."
}