Docsify-back-forth Plugin

I recommend reading through Docsify Preview

The Docsify back-forth Plugin adds a floating navigation bar to your documentation that is powered by Docsify.

---

Features

• Back and Forward Buttons: Two pairs of arrows to the bottom right corner of the screen for navigating to the previous and next document in the history.

• Responsive Design and Hover Transitions

---

Installation

1. Copy the plugin code into a new file, e.g., docsify-navigation.js.

2. Include the plugin file in your Docsify configuration, like below

   <script src="path/to/docsify-back-forth.js"></script>

---

Customization

You can customize the appearance of the navigation bar by modifying the CSS styles in the plugin code. The following CSS classes are available for customization:

• .custom-nav: Styles the overall navigation bar.
• .nav-btn: Styles the individual navigation buttons.
• .nav-icon: Styles the navigation icon (the arrow).
• .nav-text: Styles the navigation button text.

For example, you can change the background color of the navigation buttons by modifying the background-color property in the .nav-btn class.

---

Compatibility

• The plugin is designed to work with the standard Docsify navigation system. It may not work with custom navigation implementations.
• The plugin does not provide any additional functionality beyond the basic back and forward navigation. It is a simple, lightweight solution for enhancing the user experience.

---

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check issues page.

---

Todo

• More animations to choose
• Color : pick the docsify theme accent
• Compatible with mobile view

License

Copyright ©️ 2024 Sanjay0302

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.