Search documentation about nsubstitute

[dtchepak]

Site updated to include search page. Am leaving it standalone rather than incorporated into the UI at the moment. If there's demand for it we can look at updating the UI design to include a search element. :)

[MNF]

Any reason, why it is still not implemented? When I already have Nsubstitute documentation site https://nsubstitute.github.io opened and want to find some keyword, I had to open Google to search item on your site. It will be good to have search function on your docs site.

[dtchepak]

@MNF No good reason. Thanks for reminding me of this. 👍

If you have any time free would you be able to take a look at this? The docs can be a bit tricky to work with (https://github.com/nsubstitute/NSubstitute/wiki/Working-with-documentation), but if you could post some HTML/CSS somewhere I'm happy to incorporate it into the templates from there. Otherwise I'll try to get this done when I'm next working on documentation changes.

[dtchepak]

@MNF Can you give me some examples of keywords you've searched for?

I've been playing around with a Google Custom Search Engine but not sure how useful the results are for such a relatively small amount of content. (You can try it out here.) We may be better off with Lunr.js as described in posts like this, so we can exclude the navigation areas from the indexed page data.

---

For my reference, here's the sample post page I was trying out:

---
title: Search
layout: post
---
<script>
  (function() {
    var cx = '005697633880271604295:lw9srlgcpg8';
    var gcse = document.createElement('script');
    gcse.type = 'text/javascript';
    gcse.async = true;
    gcse.src = 'https://cse.google.com/cse.js?cx=' + cx;
    var s = document.getElementsByTagName('script')[0];
    s.parentNode.insertBefore(gcse, s);
  })();
</script>
<gcse:search></gcse:search>

Also need some help on where to shove a search box into the site and a nice style for it from someone who isn't horrible at design. 😄

[MNF]

 As examples of keywords, last time I wanted to find information about new Configure() extension , sometime in the past I wanted "Received() example".
Your Google Custom Search results looks good for me.

Quickly browsing Lunr.js documentation I noticed that they are working with JavaScript objects and do not parse/index html pages out of the box.

Sorry, but I am not good with UI design either.