Merge pull request #45 from progval/build-crosswalks

Use native Hugo templating to generate crosswalks

Author: moranegg

.github/workflows/check.yml

@@ -4,6 +4,10 @@ on:
   # Runs on pushes targeting any branch and on pull requests
   push:
   pull_request:
+  schedule:
+    # rebuild every day at 2:13 UTC, to apply any change to the crosswalk
+    # table made in https://github.com/codemeta/codemeta
+    - cron: "13 2 * * *"
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -21,6 +25,9 @@ jobs:
           DEBIAN_FRONTEND=noninteractive sudo apt-get install -y hugo
       - name: Checkout
         uses: actions/checkout@v3
+      - name: Prepare data files
+        run: |
+          make
       - name: Build with Hugo
         run: |
           hugo

.github/workflows/deploy.yml

@@ -36,6 +36,9 @@ jobs:
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v3
+      - name: Prepare data files
+        run: |
+          make
       - name: Build with Hugo
         env:
           # For maximum backward compatibility with Hugo modules

Makefile

@@ -0,0 +1,9 @@
+all: data/crosswalk.json
+
+# Download the latest crosswalk
+data/crosswalk.csv:
+	wget https://github.com/codemeta/codemeta/raw/master/crosswalk.csv -O data/crosswalk.csv
+
+# Convert crosswalk.csv to crosswalk.json so Hugo can parse it
+data/crosswalk.json: data/crosswalk.csv
+	python3 scripts/crosswalk_to_json.py

README.md

@@ -1,5 +1,10 @@
 # CodeMeta Website
 
-This website is written in [Hugo](https://hugodocs.info).  Hugo is the static website engine behind the wonderful RStudio package `blogdown`, and is fast, popular, and easy to install and theme. See the [Hugo docs](https://hugodocs.info) for a quick orientation on how the site is organized.  `blogdown` makes it easy to run Hugo from the RStudio editor and include R code in `.Rmd` content in Hugo sites.  
+This website is written in [Hugo](https://hugodocs.info).  Hugo is a static website engine, which is fast, popular, and easy to install and theme. See the [Hugo docs](https://hugodocs.info) for a quick orientation on how the site is organized.
 
-To build and preview the site from RStudio, just use `blogdown::serve_site()`.  `blogdown::install_hugo()` will get you set up the first time.  
+Before building the site, you should run the `make` command, in order to download the crosswalk locally; which is used by Hugo to generate the content of crosswalk pages.
+
+Then, at your option:
+
+* To build the site to `../website`, run `hugo`. You may then open that folder in your browser, or
+* To previous the site directly without RStudio, run `hugo serve`, which will make the site available at http://localhost:1313/

content/crosswalk/R.Rmd

@@ -0,0 +1,9 @@
+---
+title: "Crosswalk for R Packages"
+image: "/img/R.png"
+date: "2017-06-01"
+---
+
+The following table displays the crosswalk mapping of terms from the R package DESCRIPTION file to codemeta properties.
+
+{{< crosswalk name="R Package Description" >}}