diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index e7be44b..f970359 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -10,6 +10,7 @@ on: permissions: contents: write + pull-requests: write jobs: deploy: @@ -39,7 +40,8 @@ jobs: if ($action -eq 'closed') { mike delete --push $version } else { - mike deploy --push $version + mike deploy --push $version --prop-set hidden=true + gh pr comment $prNumber --body "Documentation preview available at https://psmodule.github.io/docs-test/$version/" } } else { mike deploy --push --update-aliases 0.3 latest diff --git a/docs/about.md b/docs/about.md new file mode 100644 index 0000000..d035480 --- /dev/null +++ b/docs/about.md @@ -0,0 +1,13 @@ +# About This Site + +This is a test documentation site built with MkDocs and Material theme. + +## Features + +- Versioned documentation using Mike +- Automated deployment via GitHub Actions +- Pull request previews + +## Getting Started + +To contribute, create a pull request and see the preview at `pr-{number}`. diff --git a/mkdocs.yml b/mkdocs.yml index 0df2765..b45bd19 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,7 +6,6 @@ extra: version: provider: mike alias: true - default: latest plugins: - mike: alias_type: symlink