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: docs/publishing/github-pages.qmd
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -117,19 +117,19 @@ Here are all of the available command line options for `quarto publish gh-pages`
117
117
118
118
{{< include _cli-options.md >}}
119
119
120
-
###GitHub Action
120
+
## GitHub Action
121
121
122
122
Using the `quarto publish {{< meta provider >}}` command to publish locally rendered content is the most simple and straightforward way to publish. Another option is to use [GitHub Actions](https://docs.github.com/en/actions) to render and publish your site (you might prefer this if you want execution and/or rendering to be automatically triggered from commits).
123
123
124
124
There are a few different ways to approach rendering and publishing content. Below, we'll provide a how-to guide for publishing with GitHub Actions. For more conceptual background on the various approaches, see the discussion on [Rendering for CI](ci.qmd#rendering-for-ci).
125
125
126
-
####Freezing Computations
126
+
### Freezing Computations
127
127
128
128
{{< include _freeze-basics.md >}}
129
129
130
130
Note that an alternative approach is to execute the code as part of the GitHub Action. For now we'll keep things simpler by executing code locally and storing the computations by using freeze. Then, further below, we'll cover [Executing Code](#executing-code) within a GitHub Action.
131
131
132
-
####Publish Action
132
+
### Publish Action
133
133
134
134
Before configuring the publishing action, it's important that you run `quarto publish gh-pages` locally, once. This will create the `_publish.yml` configuration required by the subsequent invocations of the GitHub Action. To do this, run the following from within your project:
135
135
@@ -173,7 +173,7 @@ Once you've done this, check all of the newly created files (including the `_fre
173
173
174
174
{{< include _github-action-executing-code.md >}}
175
175
176
-
####Example: Jupyter with venv
176
+
### Example: Jupyter with venv
177
177
178
178
Here is a complete example of a GitHub Action that installs Python, Jupyter, and package dependencies from `requirements.txt`, then executes code and renders output to GitHub Pages:
179
179
@@ -213,7 +213,7 @@ jobs:
213
213
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
214
214
```
215
215
216
-
####Example: Knitr with renv
216
+
### Example: Knitr with renv
217
217
218
218
Here is a complete example of a GitHub Action that installs R and package dependencies from `renv.lock`, then executes code and renders output to GitHub Pages:
219
219
@@ -255,7 +255,7 @@ jobs:
255
255
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
256
256
```
257
257
258
-
####Additional Options
258
+
### Additional Options
259
259
260
260
It's possible to have a Quarto project in a larger GitHub repository, where the Quarto project does not reside at the top-level directory. In this case, add a `path` input to the invocation of the `publish` action. For example:
0 commit comments