Skip to content

Integrated lunr search and fixed MathJax #81

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

Merged
merged 4 commits into from
May 17, 2020

Conversation

heethesh
Copy link
Contributor

@heethesh heethesh commented May 15, 2020

MathJax

Note that this PR overrides _includes/scripts.html in the remote theme. So the contents of the original file in the remote theme is copied and needs to be kept up-to-date from here.

  • Added a flag site.math for math enable in _config.yml.
  • Updated docs to use $..$ for inline math and $$...$$ for block math. This worked where \\(...\\) failed in some cases. The latter syntax is also still supported though.
  • Fixed few articles that had incorrect Latex syntax and did not escape some characters.

Lunr Search

  • Added support for indexing pages in assets/js/lunr-store.js. The default lunr search only supports indexing collections.
  • Improved search indexing by removing markdown special characters.
  • Removed the old Google search plugin and related files. If needed, Jekyll supports Google search directly and should be enabled by setting the search provider within _config.yml.

Tested locally on Jekyll server. Everything else looks fine.

@heethesh heethesh changed the title Fix MathJax #64 Fix MathJax May 15, 2020
@heethesh heethesh changed the title Fix MathJax Integrated lunr search and fixed MathJax May 16, 2020
@smbryan smbryan merged commit a2c75dc into RoboticsKnowledgebase:master May 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants