diff --git a/CUSTOMIZE.md b/CUSTOMIZE.md index 90f9c30a625b..d68b5f3dc307 100644 --- a/CUSTOMIZE.md +++ b/CUSTOMIZE.md @@ -92,7 +92,7 @@ scholar: first_name: [Albert, A.] ``` -If the entry matches one form of the last names and the first names, it will be underlined. Keep meta-information about your co-authors in [\_data/coauthors.yml](_data/coauthors.yml) and Jekyll will insert links to their webpages automatically. The co-author data format is as follows, +If the entry matches one form of the last names and the first names, it will be underlined. Keep meta-information about your co-authors in [\_data/coauthors.yml](_data/coauthors.yml) and Jekyll will insert links to their webpages automatically. The co-author data format is as follows, with the last names lower cased and without accents as the key: ```yaml "adams": @@ -115,7 +115,7 @@ If the entry matches one form of the last names and the first names, it will be url: https://en.wikipedia.org/wiki/Carl_Philipp_Emanuel_Bach ``` -If the entry matches one of the combinations of the last names and the first names, it will be highlighted and linked to the url provided. +If the entry matches one of the combinations of the last names and the first names, it will be highlighted and linked to the url provided. Note that the keys **MUST BE** lower cased and **MUST NOT** contain accents. This is because the keys are used to match the last names in the BibTeX entries, considering possible variations. ### Buttons (through custom bibtex keywords) diff --git a/INSTALL.md b/INSTALL.md index ad81f760ecda..71c938ff18fe 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -184,38 +184,7 @@ In its default configuration, al-folio will copy the top-level `README.md` to th ## Upgrading from a previous version -If you installed **al-folio** as described above, you can configure a [GitHub action](https://github.com/AndreasAugustin/actions-template-sync) to automatically sync your repository with the latest version of the theme. - -Go to Settings -> Actions -> General -> Workflow permissions, give Read and write permissions to GitHub Actions, check "Allow GitHub Actions to create and approve pull requests", and save your changes. - -Then go to Actions -> New workflow -> set up a workflow yourself, setup the following workflow and commit your changes: - -```yaml -name: Sync from template -on: - # cronjob trigger - schedule: - - cron: "0 0 1 * *" - # manual trigger - workflow_dispatch: -jobs: - repo-sync: - runs-on: ubuntu-latest - steps: - # To use this repository's private action, you must check out the repository - - name: Checkout - uses: actions/checkout@v4 - - name: actions-template-sync - uses: AndreasAugustin/actions-template-sync@v1 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - source_repo_path: alshedivat/al-folio - upstream_branch: master -``` - -You will receive a pull request within your repository if there are some changes available in the template. - -Another option is to manually update your code by following the steps below: +If you installed **al-folio** as described above, you can manually update your code by following the steps below: ```bash # Assuming the current directory is