feature: Added a workflow to deploy the MKDocs site to GitHub pages#5
Open
rmiravalles wants to merge 1 commit intokubeskills:mainfrom
Open
feature: Added a workflow to deploy the MKDocs site to GitHub pages#5rmiravalles wants to merge 1 commit intokubeskills:mainfrom
rmiravalles wants to merge 1 commit intokubeskills:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🧠 GROW Notebook Contribution or Question
Thanks for contributing to your student notebook or reaching out with a question!
Please complete the relevant section(s) below.
📝 Suggested PR Title
✍️ What is this PR for?
📝 Description
This is a proposal to add a GitHub Actions workflow that will deploy the MKDocs site to GitHub Pages.
From my experience, when GitHub Pages is enabled for the repo, and the Deploy from a branch is chosen under Build and Deployment, not all features of the Material theme are rendered.
When choosing GitHub Actions as Source, this workflow is triggered, and the MKDocs and Material packages are installed. This will allow the page to be displayed correctly, according to the settings defined in the
mkdocs.yml.