GitHub User and Organization Websites

GitHub User and Organization websites are described here

User and Organization Details

• MkDocs content is kept in org-name-mkdocs repo

Website Deployment

• User and Organization websites use two repos: one for the MkDocs content and the other for the website output, e.g., org-name-mkdocs and org-name.github.io
• The site is built with:

  cd ../org-name.github.io; mkdocs gh-deploy --config-file ../org-name-mkdocs/mkdocs.yml --remote-branch master
  

• The site content is pushed to the org-name.github.io repo's master branch
• The Makefile in this repo has a target for building the site

MkDocs Description

Deploying Organization and User Pages

Default URL

• The default URL for an User website is: https://user-name.github.io/user-name.github.io
• The default URL for an Organization website is: https://org-name.github.io/org-name.github.io, e.g., https://athenian-robotics.github.io/athenian-robotics.github.io/