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

Using jekyll-algolia on the documentation website #1570

Closed
pixelastic opened this Issue Mar 8, 2018 · 6 comments

Comments

Projects
None yet
2 participants
@pixelastic

pixelastic commented Mar 8, 2018

  • This is a feature request or enhancement.

Hello,

As we previously discussed (I lost track of which issue/PR it was), I'd like to feature your theme in the official jekyll-algolia documentation. But it seems that your documentation website is not yet using the v4.10.0 that includes the jekyll-algolia implementation.

image

I'm opening this issue as a way of being alerted when the new version will be deployed live, so I can update the doc on my side. I hope you don't mind me hijacking your issues for that :)

@mmistakes

This comment has been minimized.

Owner

mmistakes commented Mar 8, 2018

Not sure if the documentation site will ever use Algolia due to how Travis CI would need to be integrated and how I have it under the docs/ folder.

I built a separate repo that uses master to demo Algolia search.

@pixelastic

This comment has been minimized.

pixelastic commented Mar 8, 2018

Not sure if the documentation site will ever use Algolia due to how Travis CI would need to be integrated and how I have it under the docs/ folder.

I, too, have been frustrated with how cumbersome TravisCI can be for updating records on GitHub pages. Something I recently thought about was to replace TravisCI with Netlify (not for hosting, just for pushing records).

The way it would work would be to have Netlify listen to every push to master and run jekyll algolia in response. It won't even have to host anything, just run jekyll algolia to update your records in parallel of GitHub Pages deploying the website.

Would that be easier for you? If you're ok adding Netlify to the mix, I can write the step by step documentation.

@mmistakes

This comment has been minimized.

Owner

mmistakes commented Mar 8, 2018

I'll have to give it some thought. A lot of users clone this repo and use the /docs site as a starter.

I don't want to do further complicate that and "junk" up the repo more than it already is with additional config files. It just becomes a support bottleneck for me as I'm already constrained on time.

@mmistakes

This comment has been minimized.

Owner

mmistakes commented Mar 9, 2018

The documentation site now uses Algolia search.

I just had to add a gemfile line to my .travis.yml file and modify the build script slightly to have it find /docs on the master branch.

@mmistakes mmistakes closed this Mar 9, 2018

@pixelastic

This comment has been minimized.

pixelastic commented Mar 12, 2018

Thanks! Gonna update the documentation on my side in the coming days!

@pixelastic

This comment has been minimized.

pixelastic commented Mar 21, 2018

Updated the documentation on my side with a brand new page listing all themes: https://community.algolia.com/jekyll-algolia/themes.html

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