Skip to content

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

Default URL