Skip to content

Commit 9c9fadb

Browse files
committed
Keep main README simple and move to examples section
1 parent 4c168ac commit 9c9fadb

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

README.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,4 @@ This repository stores [Github Actions](https://github.com/features/actions) aro
66

77
## Examples
88

9-
### Template of workflow YAML file
10-
11-
See [Examples](./examples) for different YAML worflow file to render and deploy Quarto documents and projects
12-
13-
### Repositories using Quarto actions
14-
15-
- [Earthdata Cloud Cookbook](https://nasa-openscapes.github.io/earthdata-cloud-cookbook/) ([source](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook)). Book with `*.md` and `.ipynb` is built with Quarto and Python in GHA and deployed to Github Pages. [workflow file](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/blob/main/.github/workflows/quarto-render.yml).
16-
17-
- [R Manuals Quarto website](https://rstudio.github.io/r-manuals/) ([source](https://github.com/rstudio/r-manuals)) uses a complex workflow to build several books with R and Quarto and organizes them in a unique website deployed to Github pages. [workflow file](https://github.com/rstudio/r-manuals/blob/main/.github/workflows/build-website.yaml).
9+
In [Examples](./examples), you will find some YAML workflow file to serve as template to be reuse as base for your project. We are also sharing some links to real examples Github repositories using Quarto with Github Actions for rendering and deploying documents and projects. If you want to add your repository in the list, we welcome a PR.

examples/README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Examples of workflow YAML files
22

3-
## Quarto Book
3+
## Templates
44

5-
- Render a HTML Quarto Book and deploy to github pages ([`quarto-book-gh-pages`](./quarto-book-gh-pages.yaml))
5+
### Quarto Book
6+
7+
- Render a HTML Quarto Book and deploy to github pages ([`quarto-book-gh-pages`](./quarto-book-gh-pages.yaml))
8+
9+
## Repositories using Quarto actions
10+
11+
- [Earthdata Cloud Cookbook](https://nasa-openscapes.github.io/earthdata-cloud-cookbook/) ([source](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook)). Book with `*.md` and `.ipynb` is built with Quarto and Python in GHA and deployed to Github Pages. [workflow file](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/blob/main/.github/workflows/quarto-render.yml).
12+
13+
- [R Manuals Quarto website](https://rstudio.github.io/r-manuals/) ([source](https://github.com/rstudio/r-manuals)) uses a complex workflow to build several books with R and Quarto and organizes them in a unique website deployed to Github pages. [workflow file](https://github.com/rstudio/r-manuals/blob/main/.github/workflows/build-website.yaml).

0 commit comments

Comments
 (0)