Skip to content

Commit 1b5917a

Browse files
authored
Update example-01-basics.md
1 parent 28fee11 commit 1b5917a

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

examples/example-01-basics.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
# Quarto Actions: Basics
22

3-
The simplest workflow using Quarto Actions uses the `setup` and `publish` actions: [quarto-publish-example.yml](quarto-publish-example.yml).
3+
The simplest workflow using Quarto Actions uses the `setup` and `publish` actions: [quarto-publish-example.yml](quarto-publish-example.yml). Note that GitHub Pages use a `gh-pages` branch in your repository, which will be automatically created if one doesn't exist.
44

55
## GitHub Pages
66

77
1. **Add the GitHub Actions workflow to your project**
88

99
Copy [quarto-publish-example.yml](quarto-publish-example.yml) to `.github/workflows/quarto-publish.yml`. Uncomment the "Publish to GitHub Pages (and render)" action. No further changes are needed to the action (in particular, do *not* edit the line below to add a secret to this file. This file has the same permissions as your repository, and might be publicly readable)
10+
11+
2. **Add `_publish.yml` to your repository**
12+
13+
Quarto stores publishing metadata information in `_publish.yml`. To create this file, run `quarto publish gh-pages` locally once.
1014

11-
Now, add and commit the workflow file you have just created, and push the result to GitHub. This should trigger a new action from GitHub that will automatically render and publish your website through GitHub pages. Note that this will create a `gh-pages` branch in your repository if one doesn't exist.
15+
Now, add and commit the workflow file you have just created, and push the result to GitHub. This should trigger a new action from GitHub that will automatically render and publish your website through GitHub pages.
1216

1317

1418
## Netlify
@@ -29,7 +33,7 @@ Now, add and commit the workflow file you have just created, and push the result
2933

3034
4. **Add `_publish.yml` to your repository**
3135

32-
Quarto stores publishing metadata information in `_publish.yml`. To create this file, run `quarto publish netlify` locally once (TODO: how does this work in an IDE?).
36+
Quarto stores publishing metadata information in `_publish.yml`. To create this file, run `quarto publish netlify` locally once.
3337

3438

3539
Finally, add and commit the files you have just created, and push the result to GitHub. This should trigger a new action from GitHub that will automatically render and publish your website through Netlify.
@@ -50,7 +54,7 @@ Finally, add and commit the files you have just created, and push the result to
5054

5155
4. **Add `_publish.yml` to your repository**
5256

53-
Quarto stores publishing metadata information in `_publish.yml`. To create this file, run `quarto publish connect` locally once (TODO: how does this work in an IDE?).
57+
Quarto stores publishing metadata information in `_publish.yml`. To create this file, run `quarto publish connect` locally once.
5458

5559
Finally, add and commit the files you have just created, and push the result to GitHub. This should trigger a new action from GitHub that will automatically render and publish your website through RStudio Connect.
5660

0 commit comments

Comments
 (0)