forked from ga4gh-beacon/beacon-v2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yaml
108 lines (100 loc) · 3.53 KB
/
mkdocs.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
site_name: Beacon v2 Documentation
site_description: 'Documentation for Beacon v2'
site_author: 'Manuel Rueda, Michael Baudis, Laureen Fromont & Beacon Developers'
copyright: '© Copyright 2021-2022, Beacon v2 Documentation Contributors'
repo_name: 'beacon-v2-unity-testing'
repo_url: https://github.com/ga4gh-beacon/beacon-v2-unity-testing
edit_uri: edit/main/docs/
repo_framework_url: https://github.com/ga4gh-beacon/beacon-v2-unity-testing/tree/main/framework/src
repo_model_url: https://github.com/ga4gh-beacon/beacon-v2-unity-testing/tree/main/models/src
extra_css: [css/theme_overrides.css]
plugins:
- search
- with-pdf:
author: Beacon API Development Team
output_path: pdf/beacon.pdf
- macros
markdown_extensions:
- toc:
toc_depth: 2-3
permalink: true
- admonition
- attr_list
- footnotes
- md_in_html
- pymdownx.critic
- pymdownx.caret
- pymdownx.details
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- pymdownx.saneheaders
- pymdownx.superfences
- pymdownx.magiclink:
hide_protocol: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- tables
- mdx_gh_links:
user: ga4gh-beacon
repo: beacon-v2-unity-testing
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
nav:
- Introduction to Beacon v2: index.md
- Documentation Scopes: roles.md
- Changes: bugs-changes-log.md
- Beacon Types and Examples:
- Beacon Flavours: beacon-flavours.md
- Genomic Query Examples: variant-queries.md
- Implementations and Networks: implementations-and-networks.md
- Implement & Deploy a Beacon:
- Deployment Options: implement-and-deploy.md
- Standards Integration: formats-standards.md
- Beacon Reference Implementation ↗: https://b2ri-documentation.readthedocs.io/en/latest/
- Beacon Components:
- Framework: framework.md
- Models: models.md
- Filters: filters.md
- REST API: rest-api.md
- Terms List: schemas-md/beacon_terms.md
- Schemas:
- Analyses: schemas-md/analyses_defaultSchema.md
- Biosamples: schemas-md/biosamples_defaultSchema.md
- Cohorts: schemas-md/cohorts_defaultSchema.md
- Datasets: schemas-md/datasets_defaultSchema.md
- Genomic Variations: schemas-md/genomicVariations_defaultSchema.md
- Individuals: schemas-md/individuals_defaultSchema.md
- Runs: schemas-md/runs_defaultSchema.md
- External Links:
- Beacon Project ↗: http://beacon-project.io
- Github Repositories ↗: https://github.com/ga4gh-beacon/
- Read the Docs Version ↗: https://beacon-v2-unity.readthedocs.io/en/latest/
- Download PDF: pdf/beacon.pdf
theme:
# name: readthedocs
# name: windmill
name: material
logo: img/GA-logo.png
favicon: img/ga4gh_circle.ico
icon:
repo: fontawesome/brands/github-alt
palette:
primary: teal
features:
- search.highlight
- search.share
- navigation.instant
- navigation.tracking
- navigation.sections
# Options
extra:
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/genomebeacons
- icon: fontawesome/brands/github
link: https://github.com/ga4gh-beacon
# https://pypi.org/project/mkdocs-with-pdf/ for more PDF configuration ...