docs icon indicating copy to clipboard operation
docs copied to clipboard

Add search capability to docs site

Open cmontella opened this issue 8 years ago • 5 comments

Now that the number docs is increasing, mainly due to added functions, a search feature should be added to easily find what you're looking for. Unfortunately, the site is static HTML, so I don't know how search will work in that context.

cmontella avatar Dec 08 '16 01:12 cmontella

I'm willing to work on this, but first I need to know what markdown program you use to convert this to html? I have some ideas about how this could be done, but I need to know this first.

alexispurslane avatar Mar 22 '17 21:03 alexispurslane

I'm using Hugo: https://www.gohugo.io/

The build script isn't actually hosted anywhere, so I can get that up if you'd like to look at it.

cmontella avatar Mar 23 '17 05:03 cmontella

That would help a lot! Thanks.

alexispurslane avatar Mar 23 '17 14:03 alexispurslane

Okay, here is the build source. This is targeting a folder local to my desktop, so it won't work out of the box for you probably.

Before you invest too much time in this project, keep in mind that the docs will ultimately be moving inside of Eve itself, so this will eventually be abandoned. So if it's taking too much effort (I don't know how much will be involved) then don't worry about getting too far. Either way, thanks for looking into it!

hugoeve.zip

cmontella avatar Mar 25 '17 00:03 cmontella

There's a simple way to get this working which (hopefully) shouldn't take too long: Hugo allows simple template headers to be put around the markdown docs (which seems to be what you're doing already, I'll have to look at that build script). All I would need to do is plug in google page search.

alexispurslane avatar Mar 25 '17 00:03 alexispurslane