Skip to content

Commit 091ac3f

Browse files
amfrieszamfriesz
authored
Merge pull request #1 from ESIPFed/copilot/create-quarto-site-resource
Set up Quarto website with GitHub Pages deployment
2 parents 287a956 + 8af1d1a commit 091ac3f

7 files changed

Lines changed: 175 additions & 1 deletion

File tree

‎.github/workflows/publish.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Publish Quarto Site
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: false
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checkout repository
23+
uses: actions/checkout@v4
24+
25+
- name: Setup Quarto
26+
uses: quarto-dev/quarto-actions/setup@v2
27+
28+
- name: Render Quarto Project
29+
run: quarto render
30+
31+
- name: Upload Pages artifact
32+
uses: actions/upload-pages-artifact@v3
33+
with:
34+
path: _site
35+
36+
deploy:
37+
needs: build
38+
runs-on: ubuntu-latest
39+
environment:
40+
name: github-pages
41+
url: ${{ steps.deployment.outputs.page_url }}
42+
steps:
43+
- name: Deploy to GitHub Pages
44+
id: deployment
45+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
/.quarto/
2+
/_site/
3+
/.Rproj.user
4+
.Rhistory
5+
.RData
6+
.Ruserdata
7+
*.Rproj

‎README.md‎

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,55 @@
1-
# ai-readiness-primer
1+
# AI Readiness Primer
2+
3+
A primer resource for AI readiness in the community, hosted as a Quarto website via GitHub Pages.
4+
5+
## About
6+
7+
This repository hosts resources consolidated into a primer for community use. The site is built using [Quarto](https://quarto.org/) and automatically published to GitHub Pages.
8+
9+
## View the Site
10+
11+
The published site is available at: https://esipfed.github.io/ai-readiness-primer/
12+
13+
## Local Development
14+
15+
### Prerequisites
16+
17+
- [Quarto](https://quarto.org/docs/get-started/) installed on your system
18+
19+
### Building Locally
20+
21+
To preview the site locally:
22+
23+
```bash
24+
quarto preview
25+
```
26+
27+
To render the site:
28+
29+
```bash
30+
quarto render
31+
```
32+
33+
The rendered site will be in the `_site` directory.
34+
35+
## Contributing
36+
37+
Contributions are welcome! To contribute:
38+
39+
1. Fork the repository
40+
2. Create a new branch for your changes
41+
3. Make your changes to the `.qmd` files
42+
4. Test locally with `quarto preview`
43+
5. Submit a pull request
44+
45+
## Project Structure
46+
47+
- `_quarto.yml` - Quarto project configuration
48+
- `index.qmd` - Homepage content
49+
- `about.qmd` - About page content
50+
- `styles.css` - Custom CSS styles
51+
- `.github/workflows/publish.yml` - GitHub Actions workflow for publishing
52+
53+
## Deployment
54+
55+
The site is automatically built and deployed to GitHub Pages when changes are pushed to the `main` branch. The workflow uses GitHub Actions and the official Quarto action.

‎_quarto.yml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
project:
2+
type: website
3+
output-dir: _site
4+
5+
website:
6+
title: "AI Readiness Primer"
7+
description: "A primer resource for AI readiness in the community"
8+
navbar:
9+
left:
10+
- href: index.qmd
11+
text: Home
12+
- href: about.qmd
13+
text: About
14+
15+
format:
16+
html:
17+
theme: cosmo
18+
css: styles.css
19+
toc: true

‎about.qmd‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: "About"
3+
---
4+
5+
## About This Project
6+
7+
The AI Readiness Primer is a collaborative effort to provide resources and guidance for organizations and individuals looking to understand and prepare for AI adoption.
8+
9+
## Purpose
10+
11+
This primer aims to:
12+
13+
- Provide foundational knowledge about AI readiness
14+
- Consolidate best practices and resources
15+
- Support community learning and collaboration
16+
- Enable organizations to assess and improve their AI readiness
17+
18+
## Community
19+
20+
This project is maintained by ESIP Fed and welcomes contributions from the community.

‎index.qmd‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: "AI Readiness Primer"
3+
---
4+
5+
## Welcome
6+
7+
This is a primer resource for AI readiness in the community. This site consolidates resources and information to help organizations and individuals prepare for and adopt AI technologies effectively.
8+
9+
## Getting Started
10+
11+
Explore the resources available in the navigation menu to learn more about AI readiness.
12+
13+
## Contributing
14+
15+
This is a community resource. Contributions are welcome! Please see the repository for information on how to contribute.

‎styles.css‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/* Custom styles for AI Readiness Primer */
2+
3+
:root {
4+
--primary-color: #007bff;
5+
--secondary-color: #6c757d;
6+
}
7+
8+
.navbar-brand {
9+
font-weight: 600;
10+
}
11+
12+
.quarto-title-banner {
13+
background-color: var(--primary-color);
14+
}

0 commit comments

Comments
 (0)