Skip to content

🚀 [Feature]: Publish module docs using Material on MkDocs#34

Merged
MariusStorhaug merged 54 commits intomainfrom
mkdocs
Jul 18, 2024
Merged

🚀 [Feature]: Publish module docs using Material on MkDocs#34
MariusStorhaug merged 54 commits intomainfrom
mkdocs

Conversation

@MariusStorhaug
Copy link
Member

@MariusStorhaug MariusStorhaug commented Jul 12, 2024

Description

  • Uses newest version of Build-PSModule to build the docs folder for creating the site.
  • Publish docs to GitHub Pages using MkDocs.

Breaking change notice

The pipelines now requires two more permissions to run the workflow:

permissions:
  pages: write    # Deploy to Pages
  id-token: write # Verify the deployment originates from an appropriate source

For more info, please read the permissions section in the readme

Type of change

  • 📖 [Docs]
  • 🪲 [Fix]
  • 🩹 [Patch]
  • ⚠️ [Security fix]
  • 🚀 [Feature]
  • 🌟 [Breaking change]

Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas

@MariusStorhaug MariusStorhaug self-assigned this Jul 12, 2024
@MariusStorhaug MariusStorhaug requested a review from a team as a code owner July 12, 2024 17:46
@MariusStorhaug MariusStorhaug enabled auto-merge (squash) July 18, 2024 19:54
@MariusStorhaug MariusStorhaug merged commit 0a5e46f into main Jul 18, 2024
@MariusStorhaug MariusStorhaug deleted the mkdocs branch July 18, 2024 19:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant