Skip to content

Add search capability to docs site #54

Open

Description

@cmontella

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.

Activity

  1. changed the title [-]Add search function to docs site[/-] [+]Add search capability to docs site[/+] on Dec 8, 2016
  2. alexispurslane commented on Mar 22, 2017

    @alexispurslane

    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.

  3. cmontella commented on Mar 23, 2017

    @cmontella
    ContributorAuthor

    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.

  4. alexispurslane commented on Mar 23, 2017

    @alexispurslane

    That would help a lot! Thanks.

  5. cmontella commented on Mar 25, 2017

    @cmontella
    ContributorAuthor

    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

  6. alexispurslane commented on Mar 25, 2017

    @alexispurslane

    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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions