bioschemas-ghpages-markup-tutorial

Overview

• Name: Tutorial on adding Bioschemas markup to GitHub pages
• Description: This tutorial shows how to add Bioschemas markup to GitHub pages. It uses a simple GitHub page hosted in the gh-pages branch to create a sample project page, i.e., as learners could do with their own GitHub projects. As an example, it uses the software and data corresponding to the released project TREC-doc-2-doc-relevance, a web-based interface to add document-to-document relevance assessments to pairs of documents retrieved from TREC 2005 Genomics Track.
• Keywords: Bioschemas, schema.org, structured markup, GitHub pages

 Questions

• How can I add Bioschemas markup to GitHub pages?
• Can I also use schema.org types not included in Bioschemas?
• How can I use Bioschemas profiles? In particular ComputationalTool and Dataset (bonus, we also use TrainingMaterial to describe the tutorial itself)

 Learning outcomes

• Describe how schema.org and Bioschemas markup can be embedded to GitHub pages
• Use schema.org and Bioschemas profiles on GitHub pages
• Use schema and Bioschemas validators

 Requirements

• Understanding of what is Bioschemas and what are Bioschemas types and profiles
• Familiarity on how to use GitHub
• Basic knowledge on how to use GitHub pages. More information at GitHub Pages
• Familiarity with JSON-LD
• Basic knowledge on Markdown
• Knowledge of develop tools on a browser

 Time estimation 30 minutes

 Level Beginner / Introductory

 Published 2024-02-05

 Latest modification 2024-09-19

 License CC-By 4.0

 Version 1.1.0

 Identifier DOI:10.5281/zenodo.13799121

 Citation Castro, LJ. (2024, September 19). Adding Bioschemas Dataset and ComputationalTool markup to GitHub pages. Zenodo. https://doi.org/10.5281/zenodo.13799121 

Learning experience

Agenda

In this tutorial we will cover:

• Creating this GitHub page
• Adding schema.org and Bioschemas markup
• Visualizing the structured markup
• Validating the pages against the schema Validator
• Validating against the Rich Results Test
• Validating the pages against FAIR-Checker/Bioschemas validator
• Creating a sitemap
• Try it out

Files in this record

• PDF with full tutorial
• ZIP and TAR for the fisrt release corresponding to the tutorial (branch main, files bioschemas-ghpages-markup-tutorial-tutorial.zip and bioschemas-ghpages-markup-tutorial-tutorial.tar.gz)
• ZIP and TAR for the fisrt release corresponding to the GitHub pages used in the tutorial (branch gh-pages, files bioschemas-ghpages-markup-tutorial-pages.zip and bioschemas-ghpages-markup-tutorial-pages.tar.gz)

Acknowledgements

This tutorial is based on bioschemas-github-markup-example and Adding schema.org to a GitHub Pages site.

LJC has received fundings from the German Research Foundation (DFG) via the grant for NFDI4DataScience No. 460234259](https://gepris.dfg.de/gepris/projekt/460234259)

We use free SVG icons from Font Awesone