mirror of
https://github.com/getpelican/pelican.git
synced 2025-10-15 20:28:56 +02:00
Rename default branch to main
This commit is contained in:
parent
28e54106f2
commit
36ebe91af7
7 changed files with 17 additions and 17 deletions
|
|
@ -28,7 +28,7 @@ Environment variables can also be used here but must be escaped appropriately::
|
|||
|
||||
Settings are configured in the form of a Python module (a file). There is an
|
||||
`example settings file
|
||||
<https://github.com/getpelican/pelican/raw/master/samples/pelican.conf.py>`_
|
||||
<https://github.com/getpelican/pelican/raw/main/samples/pelican.conf.py>`_
|
||||
available for reference.
|
||||
|
||||
To see a list of current settings in your environment, including both default
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ To generate its HTML output, Pelican uses the `Jinja
|
|||
<https://palletsprojects.com/p/jinja/>`_ templating engine due to its flexibility and
|
||||
straightforward syntax. If you want to create your own theme, feel free to take
|
||||
inspiration from the `"simple" theme
|
||||
<https://github.com/getpelican/pelican/tree/master/pelican/themes/simple/templates>`_.
|
||||
<https://github.com/getpelican/pelican/tree/main/pelican/themes/simple/templates>`_.
|
||||
|
||||
To generate your site using a theme you have created (or downloaded manually
|
||||
and then modified), you can specify that theme via the ``-t`` flag::
|
||||
|
|
@ -368,7 +368,7 @@ period_num A tuple of the form (``year``, ``month``, ``day``),
|
|||
|
||||
You can see an example of how to use `period` in the `"simple" theme
|
||||
period_archives.html template
|
||||
<https://github.com/getpelican/pelican/blob/master/pelican/themes/simple/templates/period_archives.html>`_.
|
||||
<https://github.com/getpelican/pelican/blob/main/pelican/themes/simple/templates/period_archives.html>`_.
|
||||
|
||||
|
||||
.. _period_archives_variable:
|
||||
|
|
|
|||
|
|
@ -89,18 +89,18 @@ Publishing a User Site to GitHub Pages from a Branch
|
|||
----------------------------------------------------
|
||||
|
||||
To publish a Pelican site in the form of User Pages, you need to *push* the
|
||||
content of the ``output`` dir generated by Pelican to the ``master`` branch of
|
||||
content of the ``output`` dir generated by Pelican to the ``main`` branch of
|
||||
your ``<username>.github.io`` repository on GitHub.
|
||||
|
||||
Again, you can take advantage of ``ghp-import``::
|
||||
|
||||
$ pelican content -o output -s pelicanconf.py
|
||||
$ ghp-import output -b gh-pages
|
||||
$ git push git@github.com:elemoine/elemoine.github.io.git gh-pages:master
|
||||
$ git push git@github.com:elemoine/elemoine.github.io.git gh-pages:main
|
||||
|
||||
The ``git push`` command pushes the local ``gh-pages`` branch (freshly updated
|
||||
by the ``ghp-import`` command) to the ``elemoine.github.io`` repository's
|
||||
``master`` branch on GitHub.
|
||||
``main`` branch on GitHub.
|
||||
|
||||
.. note::
|
||||
|
||||
|
|
@ -116,10 +116,10 @@ inside the ``Pelican`` folder you can run::
|
|||
|
||||
$ pelican content -o .. -s pelicanconf.py
|
||||
|
||||
Now you can push the whole project ``<username>.github.io`` to the master
|
||||
Now you can push the whole project ``<username>.github.io`` to the main
|
||||
branch of your GitHub repository::
|
||||
|
||||
$ git push origin master
|
||||
$ git push origin main
|
||||
|
||||
(assuming origin is set to your remote repository).
|
||||
|
||||
|
|
@ -127,7 +127,7 @@ Publishing to GitHub Pages Using a Custom GitHub Actions Workflow
|
|||
-----------------------------------------------------------------
|
||||
|
||||
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>`_.
|
||||
<https://github.com/getpelican/pelican/blob/main/.github/workflows/github_pages.yml>`_.
|
||||
To use it:
|
||||
|
||||
1. Enable GitHub Pages in your repo: go to **Settings → Pages** and choose
|
||||
|
|
@ -144,7 +144,7 @@ To use it:
|
|||
workflow_dispatch:
|
||||
jobs:
|
||||
deploy:
|
||||
uses: "getpelican/pelican/.github/workflows/github_pages.yml@master"
|
||||
uses: "getpelican/pelican/.github/workflows/github_pages.yml@main"
|
||||
permissions:
|
||||
contents: "read"
|
||||
pages: "write"
|
||||
|
|
@ -152,7 +152,7 @@ To use it:
|
|||
with:
|
||||
settings: "publishconf.py"
|
||||
|
||||
You may want to replace the ``@master`` with the ID of a specific commit in
|
||||
You may want to replace the ``@main`` with the ID of a specific commit in
|
||||
this repo in order to pin the version of the reusable workflow that you're using:
|
||||
``uses: getpelican/pelican/.github/workflows/github_pages.yml@<COMMIT_ID>``.
|
||||
If you do this you might want to get Dependabot to send you automated pull
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue