Hosting Documentation on GitHub Pages

Markdown files on GitHub are rendered as plain HTML and can easily be read. However, they can be themed to be far more readable using GitHub Pages

Setup a GitHub Pages Site on Your Repo

1. Go to your repo on GitHub
2. Go to the Settings tab
3. Click Pages in the sidebar menu
4. Set up the site settings:
   • Deploy from a branch
   • Branch main
   • Folder /docs
5. Save the settings
6. Wait for the site to delopy (see progress under repo Actions tab)

Viewing the Documentation Site

Access the GH Pages site URL via:

• Under the repo Settings, go to Pages and see the URL
• Under the repo home page, click Deployments in right panle to see the URL

You will see the markdown documentation rendered using a clear and easy-to-read theme.