Skip to content

GitHub Action that builds a Pelican project and deploys it to GitHub Pages.

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

josemlp91/gh-pages-pelican-action

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Pages Pelican Build Action

This action builds a Pelican project and deploys it to GitHub Pages.

Please ensure a requirements.txt is present for your site and installs pelican and other requirements needed to build your site.

A requirements.txt can be generated by running pip freeze > requirements.txt in the virtual environment your pelican site is developed in.

Environment variables

  • GH_PAGES_BRANCH (optional): override the default gh-pages deployment branch
  • PELICAN_CONFIG_FILE (optional): override the default pelicanconf.py config file
  • PELICAN_CONTENT_FOLDER (optional): override the default content content folder
  • PELICAN_THEME_FOLDER (optional): setup the theme folder with package.json file, it is required if you need install node modules.
  • GITHUB_TOKEN: (required) should be ${{secrets.GITHUB_TOKEN}}, see the workflow demo in the demo repository for an example of this. This secret is fulfilled by GitHub.

Demo

Repository: https://github.com/nelsonjchen/pelican-action-demo

Website: https://pelican-action-demo.mindflakes.com/

History

Extracted from https://github.com/desertpy/desertpy-pelican.

It is not used there anymore though. For most sites though, this should suffice.

About

GitHub Action that builds a Pelican project and deploys it to GitHub Pages.

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Shell 62.5%
  • Dockerfile 37.5%