Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Maven site + search capabilities

Recently in our organisation we've decided to work with maven site plugin and maintain all the documentation about our project in the site generated by maven. However I haven't found any way to add a search functionality, the only thing I've come across that some skins provide an integration with the google search engine, but I can't use it because we're running in our own network and there is no chance to make it 'indexable' from outside.

So, my question is whether someone can suggest a descent solution for this? I thought about developing a kind of maven plugin that would run lucene and index everything by itself and then provide an API to use this search from within the site, but I hope I won't need to reinvent the wheel :) So any suggestion will be welcome here

Thanks in advance

like image 726
Mark Bramnik Avatar asked Jan 17 '13 07:01

Mark Bramnik


3 Answers

Just an idea, you can try to use JavaScript based full-text search engine e.g. http://jssindex.sourceforge.net/

like image 88
maneo Avatar answered Sep 19 '22 01:09

maneo


We are using constellio to index the published site on a schedule. That works well so far.

I've raised http://jira.codehaus.org/browse/MSKINS-88 to cover adding a generic search form to the fluido skin which we use to build our maven sites. Hopefully that'll be progressed and we can have the search form baked into the documentation.

like image 39
barnyr Avatar answered Sep 19 '22 01:09

barnyr


I know this is an old question, but a very easy (and admittedly ugly) way to accomplish what you want is simply generating a PDF with the site contents and letting your users do the search on the PDF. The advantage over searching on the generated site is that any PDF reader will be able to search the whole document.

mvn pdf:pdf
like image 45
Akira Avatar answered Sep 19 '22 01:09

Akira