{"_id":"@dogatana/honkit-plugin-back-to-top-button","_rev":"1-91c8ced46f8aff0c0b764146a8fb8ae1","name":"@dogatana/honkit-plugin-back-to-top-button","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@dogatana/honkit-plugin-back-to-top-button","version":"1.0.0","description":"Adds a back to top button to your Honkit","main":"index.js","license":"Apache-2.0","authors":["STÜBER SYSTEMS <gitbook@stueber.de>","dogatana <dogatana@gmail.com>"],"engines":{"gitbook":">=3.1.1"},"homepage":"https://github.com/dogatana/honkit-plugin-back-to-top-button","repository":{"type":"git","url":"git+https://github.com/dogatana/honkit-plugin-back-to-top-button.git"},"bugs":{"url":"https://github.com/dogatana/honkit-plugin-back-to-top-button/issues"},"publishConfig":{"access":"public"},"gitHead":"e1d3cc0a1709a85a6d63736ac2c9c46f9b86a1b2","_id":"@dogatana/honkit-plugin-back-to-top-button@1.0.0","_nodeVersion":"12.18.1","_npmVersion":"6.14.5","dist":{"integrity":"sha512-trhiP2mwm1KEs2MNdAbMHb5N8BIaOsy55CMzBcsFOE22ZgLZvrKABpq3ICcyd0cpAOpi391usI97Iptxb72zzQ==","shasum":"cf82973ab549f5599515e03f46c2109a1ba4cf3f","tarball":"https://registry.npmjs.org/@dogatana/honkit-plugin-back-to-top-button/-/honkit-plugin-back-to-top-button-1.0.0.tgz","fileCount":7,"unpackedSize":40447,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfv1M9CRA9TVsSAnZWagAAV98P/2Fu8N0gklWsvB1hsduE\nGQGzRFXuXIemrp8UWE/Rk5C+i6WI9iwgVCm7AAFYje0l1etxZ9Kv/Y7/WywN\naIw3ctY45mmjJIepjIMyKYiehNUbutk510c6nchNg6OkvNikHRDq2VbUdue+\nQZsrbav3AmjWLAlAKJTuro83wlHxyU2ErVORz5uFLqN2ZJWFLCkATca/ktui\n1EYmveCW19LxxN/lwvK2ESkZiM4sg984nVrYAoWLTKJ+77f5z4mGa+choioi\nQb9N3TWSaVVk3OoqUmDorBNheJJzrnYZUe0mjQOk5LPP175a0FgP5q0kgIt5\nZjcRegs8dkN9h1CWq+Rhs8WVtNqtqwFalkerQIUUfIYYI1JabWUuPRO+oiri\nnnKXm2pt3w+Kptk4RXBBw9KMrqXTLTJBpmX/uX1o/Xu5KEYkcY+EtJbCssUt\nUjNeGRT6UhcQgn0mJjkCzrYn7o+B60KxOvPNrpExiXzSH1AyS50ZWww9baTv\nd4OHh71x6RTBU+Eo4HtUegQBeijDOYSxmzJLk/3rXe6kEfHxydmcIlvCjS+l\nkSdhX08xnNTOhLZWeof/h3DE3y3NdJ3thxvxZ67LanUPUmD19swHJremMq0f\nlooNePrJtgAfNE29i3jMv8RDy+Wjk7cn0+i6IC+YSe790YJfgYmGwzPZTWC3\nQNP6\r\n=Gzw/\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDM54h08+RxEJV3bftRSMQMshUNBqUv+eYOvxq/jwNblQIhALvE0NCFEZqy3tJ1WeYm2vbiwYiHMR87urZ98BOP5uKh"}]},"_npmUser":{"name":"dogatana","email":"dogatana@gmail.com"},"directories":{},"maintainers":[{"name":"dogatana","email":"dogatana@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/honkit-plugin-back-to-top-button_1.0.0_1606374204665_0.5046676128040841"},"_hasShrinkwrap":false}},"time":{"created":"2020-11-26T07:03:24.628Z","1.0.0":"2020-11-26T07:03:24.871Z","modified":"2022-04-05T05:06:18.012Z"},"maintainers":[{"name":"dogatana","email":"dogatana@gmail.com"}],"description":"Adds a back to top button to your Honkit","homepage":"https://github.com/dogatana/honkit-plugin-back-to-top-button","repository":{"type":"git","url":"git+https://github.com/dogatana/honkit-plugin-back-to-top-button.git"},"bugs":{"url":"https://github.com/dogatana/honkit-plugin-back-to-top-button/issues"},"license":"Apache-2.0","readme":"# Honkit Back to Top Button Plugin \n\nThis plugin adds a back to top button to your Honkit. All three Honkit themes (White, Sepia, Night) are supported.\n\n## Usage\n\nAdd the plugin to your `book.json`:\n\n```\n{\n\t\"plugins\" : [ \"@dogatana/back-to-top-button\" ]\n}\t\t\n```\n\n## Screenshots\n\nThe back to top button in action:\n\n![Screenshots](screenshots.png)\n\n## Fork of gitbook-plugin-back-to-top-button\n\nhonkit-plugin-back-to-top is a fork of https://github.com/stuebersystems/gitbook-plugin-back-to-top-button\n\nThis plugin has more features to customize.\n\n### icon\n\nYou can choose button glyph like following.\n\n#### Use another FontAwesome icon\n\n`book.json`\n\n```js\n    \"pluginsConfig\": {\n        \"back-to-top-button\": {\n            \"icon\": \"<i class='fa fa-angle-up'></i>\"\n        }\n```\n\n`style sheet`\n\n```css\n.back-to-top i {\n    font-size: 35px;\n    top: 7px;\n    left: 14px;\n}\n\n```\n\n#### Use text label\n\n`book.json`\n\n```js\n    \"pluginsConfig\": {\n        \"back-to-top-button\": {\n            \"icon\": \"<span>TOP</span>\"\n        }\n    }\n```\n\n`style sheet`\n\n```css\n.back-to-top span {\n    position: relative;\n    color: white;\n    top: 16px;\n    left: 11px;\n}\n```\n\n### animation time\n\nYou can specify animation time to move from bottom to top.\nDefault value is 800 miliseconds.\n\n`book.json`\n```js\n    \"pluginsConfig\": {\n        \"back-to-top-button\": {\n            \"animate\": 100;\n        }\n    }\n```\n","readmeFilename":"README.md"}