Skip to content

Commit 0af4aec

Browse files
authored
Removed sync from template from INSTALL.md (#2781)
Signed-off-by: George Araújo <george.gcac@gmail.com>
1 parent 977a47c commit 0af4aec

File tree

2 files changed

+3
-34
lines changed

2 files changed

+3
-34
lines changed

CUSTOMIZE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ scholar:
9292
first_name: [Albert, A.]
9393
```
9494
95-
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,
95+
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:
9696
9797
```yaml
9898
"adams":
@@ -115,7 +115,7 @@ If the entry matches one form of the last names and the first names, it will be
115115
url: https://en.wikipedia.org/wiki/Carl_Philipp_Emanuel_Bach
116116
```
117117
118-
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.
118+
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.
119119
120120
### Buttons (through custom bibtex keywords)
121121

INSTALL.md

Lines changed: 1 addition & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -184,38 +184,7 @@ In its default configuration, al-folio will copy the top-level `README.md` to th
184184

185185
## Upgrading from a previous version
186186

187-
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.
188-
189-
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.
190-
191-
Then go to Actions -> New workflow -> set up a workflow yourself, setup the following workflow and commit your changes:
192-
193-
```yaml
194-
name: Sync from template
195-
on:
196-
# cronjob trigger
197-
schedule:
198-
- cron: "0 0 1 * *"
199-
# manual trigger
200-
workflow_dispatch:
201-
jobs:
202-
repo-sync:
203-
runs-on: ubuntu-latest
204-
steps:
205-
# To use this repository's private action, you must check out the repository
206-
- name: Checkout
207-
uses: actions/checkout@v4
208-
- name: actions-template-sync
209-
uses: AndreasAugustin/actions-template-sync@v1
210-
with:
211-
github_token: ${{ secrets.GITHUB_TOKEN }}
212-
source_repo_path: alshedivat/al-folio
213-
upstream_branch: master
214-
```
215-
216-
You will receive a pull request within your repository if there are some changes available in the template.
217-
218-
Another option is to manually update your code by following the steps below:
187+
If you installed **al-folio** as described above, you can manually update your code by following the steps below:
219188

220189
```bash
221190
# Assuming the current directory is <your-repo-name>

0 commit comments

Comments
 (0)