search

weDevsOfficial / wedocs-plugin

A documentation plugin for WordPress
https://wordpress.org/plugins/wedocs/
GNU General Public License v2.0
195 stars 93 forks source link

[FEATURE] Ctrl+K/Search box on documentation pages #166

Closed saiftheboss7 closed 11 months ago

saiftheboss7 commented 1 year ago

In a single documentation page, there should be a search box from where we can search all docs. it should be fast and work like live search.

The search should be triggered by Ctrl+K

Demo: https://tailwindcss.com/docs/installation CleanShot 2023-11-09 at 14 08 41@2x

saiftheboss7 commented 1 year ago

@anik-fahmid Work on R&D, Wireframe of this feature as well

anik-fahmid commented 1 year ago

Scope: Add a new search form on single document pages.

Description: Currently we have search from only on the docs page. We will add a search form in single doc pages below the title of the doc. The doc search form, when clicked will open a search popup. The search query result will match the title, and text of the content (as we are doing it already) and show the doc/section title or doc/article name as an Ajax search response. Please follow the Wirefrmame. The search popup will open with the command+k shortcut.

Appearance and version: The search box and popup will follow the default styles in the free version and will be updated with the tailwind, and bootstrap UI in the pro version. This feature will be available both in the free and pro versions of the plugin.

Wireframe: https://whimsical.com/search-redefined-NuhmPkDETxL4LC4nQPSSiT Video explanation: https://watch.screencastify.com/v/Z5BikZ6rZkt0h8LTfVJC Slack Thread: https://wedevs.slack.com/archives/C02M7JC9013/p1699534015464469

anik-fahmid commented 11 months ago

This feature has been released (weDocs, version 2.1.0).