EvalEx Documentation

For documentation, EvalEx uses GitHub Pages, which uses Jekyll to transform markdown to static HTML.

The sites HTML is generated automatically whenever something is committed to the main branch.

Jekyll will transform all files it finds in the "docs" directory. This may take a few minutes, depending on the overall GitHub load.

For the layout the JustTheDocs template is used, which supports a lot of good things like a sidebar menu, page hierarchy and searching.

EvalEx documentation home:

https://ezylang.github.io/EvalEx/

Using JustTheDocs template:

https://just-the-docs.github.io/just-the-docs/

Install Jekyll locally (for testing the site locally)

https://jekyllrb.com/docs/installation/

Testing locally

https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll