Skip to content
This repository has been archived by the owner on Jun 30, 2024. It is now read-only.

Commit

Permalink
Initial quarto project (#1)
Browse files Browse the repository at this point in the history
* vscode: added quarto extension to recommended extentions
* quarto: initial web project
* wp: quarto added some settings from the manual
* We are going to deploy with GHA
  • Loading branch information
CGMossa authored Feb 25, 2024
1 parent fbafe31 commit 394195b
Show file tree
Hide file tree
Showing 9 changed files with 91 additions and 1 deletion.
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 .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
/.quarto/
/_site/
13 changes: 13 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
// See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
// Extension identifier format: ${publisher}.${name}. Example: vscode.csharp

// List of extensions which should be recommended for users of this workspace.
"recommendations": [
"quarto.quarto"
],
// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
"unwantedRecommendations": [

]
}
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# user-guide
# extendR user guide

User guide for the extendr software suite: Examples, design patterns and workflows
32 changes: 32 additions & 0 deletions _quarto.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
project:
type: website

execute:
freeze: auto

website:
title: "extendr"
reader-mode: true
repo-url: https://github.com/extendr/user-guide
repo-actions: [edit, issue]
repo-branch: main
sidebar:
contents: auto
style: "docked"
search: true
navbar:
left:
- href: index.qmd
text: Home
- about.qmd

format:
html:
theme:
light: flatly
dark: darkly
css: styles.css
toc: true



5 changes: 5 additions & 0 deletions about.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "About"
---

About this site
4 changes: 4 additions & 0 deletions conversion.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Conversion to and from R data"
---

7 changes: 7 additions & 0 deletions index.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "extendR: User guide"
---

# Introduction

extendR is a suite of software packages concerned with bridging R and Rust, through automatically generated bindings. See <https://extendr.github.io/> for more information. This website is a _user_ guide to all things extendr, Rust, R and the confluence of all three.
1 change: 1 addition & 0 deletions styles.css
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/* css styles */

0 comments on commit 394195b

Please sign in to comment.