{"id":19486277,"url":"https://github.com/textbook/pelican_scaffold","last_synced_at":"2026-06-11T18:31:41.059Z","repository":{"id":36143842,"uuid":"40447848","full_name":"textbook/pelican_scaffold","owner":"textbook","description":"A simple template for Pelican sites on GitHub pages with Travis integration","archived":false,"fork":false,"pushed_at":"2017-04-16T19:28:56.000Z","size":7,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-22T01:47:42.275Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/textbook.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-08-09T19:30:20.000Z","updated_at":"2023-11-13T21:23:01.000Z","dependencies_parsed_at":"2022-09-09T12:00:41.393Z","dependency_job_id":null,"html_url":"https://github.com/textbook/pelican_scaffold","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/textbook/pelican_scaffold","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textbook%2Fpelican_scaffold","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textbook%2Fpelican_scaffold/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textbook%2Fpelican_scaffold/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textbook%2Fpelican_scaffold/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/textbook","download_url":"https://codeload.github.com/textbook/pelican_scaffold/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textbook%2Fpelican_scaffold/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34213180,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-11T02:00:06.485Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T20:36:16.216Z","updated_at":"2026-06-11T18:31:41.043Z","avatar_url":"https://github.com/textbook.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"Pelican Scaffold\n================\n\nA simple template for Pelican sites on GitHub Pages with Travis integration.\n\nIntroduction\n------------\n\n[Pelican] is a Python-powered static site generator that, when combined with\nthe hosting provided by [GitHub Pages][ghp] and automated build and CI from\n[Travis], makes it incredibly easy to manage your own blog.\n\nHowever, getting set up with a full workflow is still a little tricky. This\nrepo aims to simplify things; all you need is `git`, Python and `pip`\n(installing in a `virtualenv` is generally recommended, but not required) and\nyou can be up and running in five minutes.\n\nInstallation\n------------\n\n1. Fork this repository, check it out and `cd` into the directory.\n\n1. Run `pip install -r requirements.txt` to install Pelican and the other\n  dependencies (if you add other dependencies, remember to use `pip freeze \u003e\n  requirements.txt` to keep the list up to date).\n\n1. Run `pelican-quickstart` to create the basic Pelican files, including\n  `pelicanconf.py` and `publishconf.py` - just hit \u003ckbd\u003eEnter\u003c/kbd\u003e for most of\n  the questions, but answer the following:\n\n   - *What will be the title of this web site?*\n\n   - *Who will be the author of this web site?*\n\n   - *What is your URL prefix?* (use `http://\u003cyourname\u003e.github.io`)\n\n  It may seem odd to answer `N` to *Do you want to upload your website using\n  GitHub Pages?*, but we're dealing with that ourselves!\n\n1. This repository includes `pelican-plugins` and `pelican-themes` as\n  submodules, so you can `git submodule update --init --recursive` to download\n  the appropriate content (this might take a while, so skip ahead to updating\n  the deploy script and return once it's done).\n\n1. To use that content, set `THEME = 'pelican-themes/\u003cyourchoice\u003e'` and\n  `PLUGIN_PATHS = ['pelican-plugins']` in `pelicanconf.py`.\n\n1. Update `deploy.sh` with your GitHub username as `GH_USERNAME` to ensure\n  that the site gets published to the correct place (if you don't want to use\n  `\u003cyourname\u003e.github.io`, you will need to edit more extensively).\n\n1. Set up your forked repository on Travis; it's probably best to set it build\n only on pushes, so that pull requests don't cause any trouble. You can modify\n `.travis.yml` to match your version of Python, if required.\n\n1. Generate an authentication token for GitHub (`Settings \u003e Personal access\n  tokens \u003e Generate new token`), which will allow the deployment script to push\n  to the output repository, and add it to Travis as an environment variable\n  named `GH_PAGES`.\n\n1. If you don't have it already, create a new GitHub repository named\n `\u003cyourname\u003e.github.io` for the site to be published to.\n\n1. Commit and push this repository to kick off the build and publication of\n  the first version of your new site.\n\nVoila! You can now develop your site locally, or add new articles directly on\nGitHub in the content folder, and the live version will be updated accordingly.\nThe site will be visible online at `http://\u003cyourname\u003e.github.io`.\n\nTips\n----\n\n - A `CNAME` file is required if you want to use a custom domain with GitHub\n   Pages. The easiest way to provide this is to add an `extra` directory to\n   `content`, put the appropriate `CNAME` in that directory (see [GitHub's\n   help][domain]) and add `STATIC_PATHS.append('extra')` and\n   `EXTRA_PATH_METADATA['extra/CNAME'] = {'path': 'CNAME'}` to\n   `pelicanconf.py`. You can then set `SITEURL = \"\u003cyour.custom.domain\u003e\"` instead\n   of `SITEURL = \"http://\u003cyourname.github.io\u003e\"`\n\n - Note that `pelicanconf.py` should contain settings used for both local\n   development *and* publication, but `publishconf.py` will be used by the\n   deploy script, so you can use that for things that make local development\n   more complex (e.g. I only have the publication `SITEURL` defined in the\n   publication config so that `localhost` still works OK).\n\nAcknowledgements\n----------------\n\nThe build script (`deploy.sh`) is based heavily on [*\"How to automatically build \nyour Pelican blog and publish it to Github Pages\"*][zonca-article] by [Andrea \nZonca][zonca], with the modifications suggested in [*\"Deploying Pelican Sites \nUsing Travis CI\"*][yap-article] by [Kevin Yap][yap].\n\n [1]: \n [2]: \n [domain]: https://help.github.com/articles/adding-a-cname-file-to-your-repository/\n [ghp]: https://pages.github.com/\n [pelican]: http://docs.getpelican.com/\n [travis]: https://travis-ci.org/\n [yap]: https://github.com/iKevinY\n [yap-article]: http://kevinyap.ca/2014/06/deploying-pelican-sites-using-travis-ci/\n [zonca]: https://github.com/zonca\n [zonca-article]: http://zonca.github.io/2013/09/automatically-build-pelican-and-publish-to-github-pages.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextbook%2Fpelican_scaffold","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftextbook%2Fpelican_scaffold","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextbook%2Fpelican_scaffold/lists"}