From 394195b47e6a7f2fb1aaa1c04599c131e1d2b59e Mon Sep 17 00:00:00 2001 From: CGMossa Date: Sun, 25 Feb 2024 16:37:18 +0100 Subject: [PATCH] Initial quarto project (#1) * 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 --- .github/workflows/publish.yml | 25 +++++++++++++++++++++++++ .gitignore | 2 ++ .vscode/extensions.json | 13 +++++++++++++ README.md | 3 ++- _quarto.yml | 32 ++++++++++++++++++++++++++++++++ about.qmd | 5 +++++ conversion.qmd | 4 ++++ index.qmd | 7 +++++++ styles.css | 1 + 9 files changed, 91 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/publish.yml create mode 100644 .gitignore create mode 100644 .vscode/extensions.json create mode 100644 _quarto.yml create mode 100644 about.qmd create mode 100644 conversion.qmd create mode 100644 index.qmd create mode 100644 styles.css diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..bfcd9de --- /dev/null +++ b/.github/workflows/publish.yml @@ -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 }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..47c274c --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/.quarto/ +/_site/ diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..8aa8eb9 --- /dev/null +++ b/.vscode/extensions.json @@ -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": [ + + ] +} \ No newline at end of file diff --git a/README.md b/README.md index 9b4a136..69b5c4f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,3 @@ -# user-guide +# extendR user guide + User guide for the extendr software suite: Examples, design patterns and workflows diff --git a/_quarto.yml b/_quarto.yml new file mode 100644 index 0000000..ea60e9e --- /dev/null +++ b/_quarto.yml @@ -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 + + + diff --git a/about.qmd b/about.qmd new file mode 100644 index 0000000..07c5e7f --- /dev/null +++ b/about.qmd @@ -0,0 +1,5 @@ +--- +title: "About" +--- + +About this site diff --git a/conversion.qmd b/conversion.qmd new file mode 100644 index 0000000..d2f73ba --- /dev/null +++ b/conversion.qmd @@ -0,0 +1,4 @@ +--- +title: "Conversion to and from R data" +--- + diff --git a/index.qmd b/index.qmd new file mode 100644 index 0000000..22ca43b --- /dev/null +++ b/index.qmd @@ -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 for more information. This website is a _user_ guide to all things extendr, Rust, R and the confluence of all three. diff --git a/styles.css b/styles.css new file mode 100644 index 0000000..2ddf50c --- /dev/null +++ b/styles.css @@ -0,0 +1 @@ +/* css styles */