Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/geertvangeest/addbioschemas
https://github.com/geertvangeest/addbioschemas
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/geertvangeest/addbioschemas
- Owner: GeertvanGeest
- Created: 2024-02-22T15:27:23.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-07-25T13:05:51.000Z (6 months ago)
- Last Synced: 2024-08-01T10:29:01.740Z (5 months ago)
- Language: Python
- Size: 24.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Adding bioschemas to mkdocs
A small markdown extension to add bioschemas to mkdocs. It requires a yaml or json file with bioschemas markup, and adds it to the rendered html.
## Installation
```bash
pip install addbioschemas
```
To use the plugin simply add `addbioschemas` to the list of plugins in `mkdocs.yml`:
```yml
markdown_extensions:
- addbioschemas
```
## Usage
### Option 1: add the bioschemas file name to the markdown file
Simply add `[add-bioschemas file='path/to/yaml/metadata.yaml']` to the markdown file where you want to add the bioschemas. This method supports multiple metadata files.
A markdown snippet of a page where you want to add bioschemas to:
```markdown
# awesome title
[add-bioschemas file='path/to/yaml/metadata.yaml']
I started with some YAML and turned it into JSON-LD
```
**Important**: If you are using [mkdocs-material](https://squidfunk.github.io/mkdocs-material/), make sure there is markdown before the insertion of `[add-bioschemas]`. Otherwise, other plugins will add incorrect tags to the json-LD chunk.
The contents of `path/to/yaml/metadata.yaml` use the bioschemas properties:
```yaml
"@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: [email protected]
github: GeertvanGeest
orcid: 0000-0002-1561-078X
- "@type": Person
name: Elin Kronander
github: elinkronander
orcid: 0000-0003-0280-6318
```
`addbioschemas` also supports the json format.
### Option 2: add the bioschemas file name to mkdocs.yml
Specify the path to the yaml file in `mkdocs.yml`. This method only supports one metadata file.
Add to `mkdocs.yml`:
```yaml
markdown_extensions:
- addbioschemas:
metadata: 'path/to/yaml/metadata.yaml'
```
A markdown snippet of a page where you want to add bioschemas to:
```markdown
# awesome title
[add-bioschemas]
I started with some YAML and turned it into JSON-LD
```
**Important**: If you are using [mkdocs-material](https://squidfunk.github.io/mkdocs-material/), make sure there is markdown before the insertion of `[add-bioschemas]`. Otherwise, other plugins will add incorrect tags to the json-LD chunk.