Skip to content

Commit 5b96fc0

Browse files
committed
Move github action one level in publish doc
This match the intro mentioning 3 methods closes quarto-dev/quarto-cli#10802
1 parent 8b67e49 commit 5b96fc0

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/publishing/github-pages.qmd

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -117,19 +117,19 @@ Here are all of the available command line options for `quarto publish gh-pages`
117117

118118
{{< include _cli-options.md >}}
119119

120-
### GitHub Action
120+
## GitHub Action
121121

122122
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).
123123

124124
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).
125125

126-
#### Freezing Computations
126+
### Freezing Computations
127127

128128
{{< include _freeze-basics.md >}}
129129

130130
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.
131131

132-
#### Publish Action
132+
### Publish Action
133133

134134
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:
135135

@@ -173,7 +173,7 @@ Once you've done this, check all of the newly created files (including the `_fre
173173

174174
{{< include _github-action-executing-code.md >}}
175175

176-
#### Example: Jupyter with venv
176+
### Example: Jupyter with venv
177177

178178
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:
179179

@@ -213,7 +213,7 @@ jobs:
213213
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
214214
```
215215

216-
#### Example: Knitr with renv
216+
### Example: Knitr with renv
217217

218218
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:
219219

@@ -255,7 +255,7 @@ jobs:
255255
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
256256
```
257257

258-
#### Additional Options
258+
### Additional Options
259259

260260
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:
261261

0 commit comments

Comments
 (0)