port to quarto (#14)

* port to quarto

* add cron and remove pkgdown ga

* remove link to css file

* reuse mit license

* quarto freeze

* revert to md

* add preview note

* small e

* temp fix - add logo

* start faq and include developer info

.Rbuildignore

@@ -1,3 +1,5 @@
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$
+^.*\.Rproj$
+^\.Rproj\.user$

.github/workflows/quarto-publish.yml

@@ -0,0 +1,27 @@
+on:
+    workflow_dispatch:
+    push:
+      branches: main
+    schedule:
+      - cron: '0 0 * * 5' # Every Friday at midnight UTC
+
+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 }}

.gitignore

@@ -1,2 +1,16 @@
 docs
 *~
+.Rproj.user
+*.Rproj
+
+/.quarto/
+/_site/
+# rust specific .gitignore
+target/
+debug/
+Cargo.lock
+**/*.rs.bk
+*.pdb
+# r specific
+.Rproj.user/
+*.Rproj

CHANGELOG.md

@@ -2,76 +2,81 @@
 
 ## extendr devel
 
-- Fixed Clippy warnings
+-   Fixed Clippy warnings
 
-- Fixed "myvar" test failures - related to base_env() being the "local" enviroment in the tests.
+-   Fixed "myvar" test failures - related to base_env() being the "local"
+    enviroment in the tests.
 
-- Fixes for builds on ARM and PPC platforms.
+-   Fixes for builds on ARM and PPC platforms.
 
-- Converted R! to a procedural macro, allowing parameters.
+-   Converted R! to a procedural macro, allowing parameters.
 
-- Converted pairlist! to a procedural macro.
+-   Converted pairlist! to a procedural macro.
 
-- Refactor extendr_macros.
+-   Refactor extendr_macros.
 
-- Remove unused lazy_static
+-   Remove unused lazy_static
 
-- Continued improvments to wrappers for specific R types such as environments, functions and symbols.
+-   Continued improvments to wrappers for specific R types such as environments,
+    functions and symbols.
 
-- Install system dependencies on Linux.
+-   Install system dependencies on Linux.
 
-- Use Use failure() to trigger steps on failures
+-   Use Use failure() to trigger steps on failures
 
-- `SymPair::sym_pair()` now returns `(Option<Robj>, Robj)`
+-   `SymPair::sym_pair()` now returns `(Option<Robj>, Robj)`
 
 ## extendr 0.2.0
 
-- Added contributing guidelines and code of conduct.
+-   Added contributing guidelines and code of conduct.
 
-- Made use of ndarray optional.
+-   Made use of ndarray optional.
 
-- Made #[extendr] calls panic and thread safe.
+-   Made #\[extendr\] calls panic and thread safe.
 
-- Added NA handling to the #[extendr] macro.
+-   Added NA handling to the #\[extendr\] macro.
 
-- Added a separate extendr-engine crate that is needed when calling R from Rust.
+-   Added a separate extendr-engine crate that is needed when calling R from
+    Rust.
 
-- Wrapper classes for pairlists, environment, raw, symbols and others.
+-   Wrapper classes for pairlists, environment, raw, symbols and others.
 
-- More iterator support.
+-   More iterator support.
 
-- Operators index, slice, dollar, double_colon, +, -, * and /`.
+-   Operators index, slice, dollar, double_colon, +, -, \* and /\`.
 
-- Debug printing support expanded to use wrappers.
+-   Debug printing support expanded to use wrappers.
 
-- Conversion of Robj to wrapper types.
+-   Conversion of Robj to wrapper types.
 
-- Multithreaded support - allows multithreaded testing using a recursive spinlock.
+-   Multithreaded support - allows multithreaded testing using a recursive
+    spinlock.
 
-- Bool type extended and implemented using TRUE, FALSE and NA_BOOLEAN.
+-   Bool type extended and implemented using TRUE, FALSE and NA_BOOLEAN.
 
-- Optional parameters to support NA handing.
+-   Optional parameters to support NA handing.
 
-- Errors thrown if input parameters without Option are NA.
+-   Errors thrown if input parameters without Option are NA.
 
-- Harmonising of function names into integer, real, logical, symbol, raw, list, pairlist and env.
+-   Harmonising of function names into integer, real, logical, symbol, raw,
+    list, pairlist and env.
 
-- Refactored robj code into several source files.
+-   Refactored robj code into several source files.
 
-- Many functions updated to use generic types.
+-   Many functions updated to use generic types.
 
-- R! macro for executing R source code.
+-   R! macro for executing R source code.
 
-- call! macro to call R code.
+-   call! macro to call R code.
 
-- sym! macro to generate symbols.
+-   sym! macro to generate symbols.
 
-- Simplification of vector generation using collect_robj and ToVectorValue.
+-   Simplification of vector generation using collect_robj and ToVectorValue.
 
-- Added array types `[1, 2, 3]` as `Robj::from` targets.
+-   Added array types `[1, 2, 3]` as `Robj::from` targets.
 
-- Macros now mostly return errors.
+-   Macros now mostly return errors.
 
 ## extendr 0.1.10
 
-- Fix build on Windows and MacOS.
+-   Fix build on Windows and MacOS.

README.md

@@ -1,21 +1,5 @@
 # extendr.github.io
 
-This repository contains a dummy R project which allows us to
-build a website for Extendr using `pkgdown`.
+Repository for the **extendr** website built using [Quarto](https://quarto.org/).
 
-To build the site locally:
-
-```r
-remotes::install_github("r-lib/pkgdown")
-devtools::install()
-pkgdown::build_site()
-```
-
-There is a github action that builds the site and deploys to
-the `gh-pages` branch when pushing to `main`.
-
-On linux, you will also need:
-
-```shell
-sudo apt install fontconfig libfreetype2-dev libfontconfig1-dev libharfbuzz-dev libfribidi-dev pandoc
-```
+Website can be previewed using `quarto preview`.

_quarto.yml

@@ -0,0 +1,32 @@
+project:
+  type: website
+
+execute:
+  freeze: true
+
+website:
+  title: "extendr"
+  navbar:
+    left:
+      - text: "Getting started"
+        href: started.qmd
+      - text: Contributing
+        href: CONTRIBUTING.md
+      - text: "News"
+        href: CHANGELOG.md
+      - text: "API Docs"
+        href: https://extendr.github.io/extendr/extendr_api/
+      - text: "FAQ"
+        href: faq.qmd
+    right:
+     - icon: github
+       href: https://github.com/extendr/extendr
+     - icon: discord
+       href: https://discord.gg/7hmApuc
+
+format:
+  html:
+    theme:
+      light: flatly
+      dark: darkly    
+    toc: false

faq.css

@@ -0,0 +1,21 @@
+
+#TOC ul {
+  padding-left: 1rem;
+}
+
+#TOC ul li {
+  padding-bottom: 0.5rem;
+}
+
+#TOC ul li a {
+  text-decoration: none;
+}
+
+#toc-title,
+.toc-actions {
+  display: none;
+}
+
+.comparison ul {
+  padding-left: 1.1em;
+}