How to create your own MIP documentation site from this template.
Step 1: Create Your Repository¶
- Go to the MIP-template repository
- Click the green Use this template button
- Select Create a new repository
- Choose your organization and enter a repository name
- Click Create repository
Step 2: Configure Your Site¶
Edit mkdocs.yml directly on GitHub:
- Click on
mkdocs.ymlin your new repository - Click the pencil icon (Edit this file)
- Update these lines at the top:
site_name: Your MIP Name
site_description: Brief description of your MIP
site_author: Your Organization
site_url: https://your-org.github.io/your-repo/
- Click Commit changes
Step 3: Enable GitHub Pages¶
- Go to Settings in your repository
- Click Pages in the left sidebar
- Under "Build and deployment", select Deploy from a branch
- Select gh-pages branch and / (root) folder
- Click Save
Your site will be live at: https://YOUR-ORG.github.io/YOUR-REPO/
Note
The gh-pages branch is created automatically after your first commit to main. If you don't see it, make a small edit to any file and commit it.
Next Steps¶
- Updating Content - How to edit pages and navigation
- Testing Locally - Preview changes on your computer