Github Project Websites¶
Github Project websites are described here.
Project Details
An empty .nojekyll file is required in the root
Website Deployment¶
- The site is built with:
mkdocs gh-deploy - The site's content is pushed to the Project repo's gh_pages branch
- The Makefile in this repo has a target for building the site
MkDocs Description
Default URL¶
- The default URL for a Project website is:
https://project-name.github.io/project-name, e.g., https://github.com/gitlabzz/mkdocs-demo/