README.md

IREE User-Facing Documentation Website

This directory contains the source and assets for IREE's website, hosted on GitHub Pages.

The website is generated using MkDocs, with the Material for MkDocs theme.

How to edit this documentation

Follow https://squidfunk.github.io/mkdocs-material/getting-started/ and read https://www.mkdocs.org/.

Develop (from this folder):

mkdocs serve

Deploy:

• This force pushes to gh-pages on <your remote>. Please don't push to the main repository :)

mkdocs gh-deploy --remote-name <your remote>