You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: examples/example-01-basics.md
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,18 @@
1
1
# Quarto Actions: Basics
2
2
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.
4
4
5
5
## GitHub Pages
6
6
7
7
1.**Add the GitHub Actions workflow to your project**
8
8
9
9
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.
10
14
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.
12
16
13
17
14
18
## Netlify
@@ -29,7 +33,7 @@ Now, add and commit the workflow file you have just created, and push the result
29
33
30
34
4.**Add `_publish.yml` to your repository**
31
35
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.
33
37
34
38
35
39
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
50
54
51
55
4.**Add `_publish.yml` to your repository**
52
56
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.
54
58
55
59
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.
0 commit comments