Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
on:
workflow_dispatch:
push:
branches: main

name: Quarto Publish

jobs:
build-deploy:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Check out repository
uses: actions/checkout@v4

- name: Set up Quarto
uses: quarto-dev/quarto-actions/setup@v2

- name: Render and Publish
uses: quarto-dev/quarto-actions/publish@v2
with:
target: gh-pages
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2 changes: 2 additions & 0 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,5 @@ filters:
- include-files.lua
- quarto

execute:
freeze: auto
31 changes: 31 additions & 0 deletions how-to-publish.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# How to Publish Cookbook on GH Pages

I am following these [instructions](https://quarto.org/docs/publishing/github-pages.html#github-action) provided by Quarto.

## 1. Freeze Computations

I am only allowing code to be executed locally.

In `_quarto.yml`, I have added the following
```
execute:
freeze: auto
```

Now render the site
```
quarto render
```

If a `_freeze` directory is created, add and commit this.

## 2. Publish Action

Run

```
quarto publish gh-pages
```

Add `.github/workflows/publish.yml` and add text from quarto [instructions](https://quarto.org/docs/publishing/github-pages.html#publish-action)

2 changes: 1 addition & 1 deletion reference-guides/overview.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ author: Andy P. Barrett
This section of the cookbook contains **Reference Guides** to a
variety of topics. Reference Guides are intended to provide
background information for the [**How-To
Guides**](nsidc-data-cookbook/how-tos/overview.qmd) and [**Tutorials**](nsidc-data-cookbook/tutorials/index.qmd).
Guides**](../how-to-guides/overview.qmd).

Reference Guides are organized into the following sections:
_Maybe add a short description of each section here_
Expand Down