Skip to main content

A markdown extension to add bioschemas markup to rendered html

Project description

Adding bioschemas to mkdocs

A small markdown extension to add bioschemas to mkdocs. It requires a yaml file with bioschemas markup, and adds it to the rendered html.

Installation

pip install addbioschemas

Usage

A markdown snippet of a page where you want to add bioschemas to:

# awesome title
[add-bioschemas]
I started with some YAML and turned it into JSON-LD

A yaml file with the bioschemas markup:

"@context": https://schema.org/
"@type": LearningResource
"@id": https://elixir-europe-training.github.io/ELIXIR-TrP-LessonTemplate-MkDocs/
http://purl.org/dc/terms/conformsTo:
  "@type": CreativeWork
  "@id": https://bioschemas.org/profiles/TrainingMaterial/1.0-RELEASE
description: Template for ELIXIR lessons
keywords: FAIR, OPEN, Bioinformatics, Teaching
name: ELIXIR Training Lesson template
# lookup at https://spdx.org/licenses/
license: CC-BY-4.0
author:
- "@type": Person
  name: Geert van Geest
  email: geert.vangeest@sib.swiss
  github: GeertvanGeest
  orcid: 0000-0002-1561-078X
- "@type": Person
  name: Elin Kronander
  github: elinkronander
  orcid: 0000-0003-0280-6318

Add to mkdocs.yml:

markdown_extensions:
  - addbioschemas:
     yaml: 'path/to/yaml/metadata.yaml'

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

addbioschemas-0.0.2.tar.gz (2.5 kB view hashes)

Uploaded Source

Built Distribution

addbioschemas-0.0.2-py3-none-any.whl (2.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page