Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add search capability to docs site #54

Open
cmontella opened this issue Dec 8, 2016 · 5 comments
Open

Add search capability to docs site #54

cmontella opened this issue Dec 8, 2016 · 5 comments

Comments

@cmontella
Copy link
Contributor

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 cmontella changed the title Add search function to docs site Add search capability to docs site Dec 8, 2016
@alexispurslane
Copy link

alexispurslane commented Mar 22, 2017

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.

@cmontella
Copy link
Contributor Author

cmontella commented Mar 23, 2017

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.

@alexispurslane
Copy link

That would help a lot! Thanks.

@cmontella
Copy link
Contributor Author

cmontella commented Mar 25, 2017

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

@alexispurslane
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants