github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Docs: GitHub Pages workflow not officially supported

Browse source
This commit is contained in:
Justin Mayer 2024-05-29 07:28:22 +02:00
commit e4d7f0a9d9
2 changed files with 4 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

1
.github/workflows/github_pages.yml vendored
View file

@ -1,3 +1,4 @@
# Workflow for publishing to GitHub Pages. **NO OFFICIAL SUPPORT PROVIDED.**
name: Deploy to GitHub Pages
on:
workflow_call:

5
docs/tips.rst
View file

@ -126,8 +126,9 @@ branch of your GitHub repository::
Publishing to GitHub Pages Using a Custom GitHub Actions Workflow
-----------------------------------------------------------------
Pelican comes with a `custom workflow <https://github.com/getpelican/pelican/blob/master/.github/workflows/github_pages.yml>`_
for publishing a Pelican site. To use it:
Pelican-powered sites can be published to GitHub Pages via a `custom workflow
<https://github.com/getpelican/pelican/blob/master/.github/workflows/github_pages.yml>`_.
**No official support is provided** for this community-submitted workflow. To use it:
1. Enable GitHub Pages in your repo: go to **Settings → Pages** and choose
**GitHub Actions** for the **Source** setting.