DEV Community

Rachit Chawla
Rachit Chawla

Posted on

Introducing Search Highlighting in txtToWeb

We're excited to announce a new feature in txtToWeb, our command-line tool that converts text files to HTML content. With this latest enhancement, users can now search for specific terms within their generated HTML files, and the tool will dynamically highlight the matching results for better readability.

How Does It Work?

The search highlighting feature in txtToWeb operates seamlessly. After generating HTML files from text documents, users can open any HTML file in their browser. Upon entering a search term and clicking the search button, txtToWeb will instantly highlight all instances of the search term within the content of the HTML file, making it easier for users to locate specific information.

What Problem Does It Solve?

Searching through extensive text-based content for specific information can be time-consuming. txtToWeb's new search highlighting feature addresses this challenge by providing a quick and efficient way to locate relevant content within generated HTML files.

What Did We Build?

We added a JavaScript-based search functionality to the HTML files generated by txtToWeb. The feature includes an input field for users to enter search terms and a button to initiate the search. When a user enters a term and clicks the button, the tool highlights all instances of the term within the content.

Inspiration from Docusaurus

While Docusaurus uses TypeScript for its search highlighting functionality, we drew inspiration from their approach to enhance the user experience. Docusaurus's seamless search experience motivated us to implement a similar feature in txtToWeb, allowing users to efficiently search through their documentation-style HTML files.We also utilized regular expressions for global, case-insensitive searching, a technique common in various web applications. However, unlike Docusaurus, our tool primarily focuses on offline content conversion, making it a versatile solution for converting local text files into searchable HTML documents.

Link to the issue: Issue 13
Link to the commit: 46be038

Top comments (0)