CODEWITHSUNDEEP
mavenfull-text-searchmaven-site-plugin
Mark Bramnik
Mark Bramnik

Reputation: 42531

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

Upvotes: 7

Views: 972

Answers (5)

Akira
Akira

Reputation: 4071

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

Upvotes: 1

barnyr
barnyr

Reputation: 5678

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.

Upvotes: 2

Paul Verest
Paul Verest

Reputation: 63982

Maven site plugin approach is not widely used. So there is nothing specific for indexing yet. You should look at non-maven tools.

Upvotes: 0

Marcel Stör
Marcel Stör

Reputation: 23565

If you cannot use Google Site Search you're dependent on local search implementations. Hence, you either need to build the index during the site build (and for it to be available as part of your site) or do both index and search in the browser.

Besides JSSindex which appears to be somewhat dated there's http://www.tipue.com/search/ which is based on jQuery.

Upvotes: 0

maneo
maneo

Reputation: 39

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

Upvotes: 2

Related Questions