forked from ga4gh-beacon/beacon-v2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yaml
121 lines (113 loc) · 3.92 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
109
110
111
112
113
114
115
116
117
118
119
120
121
site_name: Beacon v2 Documentation
site_description: 'Documentation for Beacon v2'
site_author: 'Michael Baudis, Manuel Rueda, Laureen Fromont & Beacon Developers'
copyright: '© Copyright 2021-2023, Beacon v2 Documentation Contributors'
repo_name: 'beacon-v2'
repo_url: https://github.com/ga4gh-beacon/beacon-v2
edit_uri: edit/main/docs/
repo_framework_icon: " [:fontawesome-brands-github:](https://github.com/ga4gh-beacon/beacon-v2/tree/main/framework/src)"
repo_models_icon: " [:fontawesome-brands-github:](https://github.com/ga4gh-beacon/beacon-v2/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
- mermaid2
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
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:mermaid2.fence_mermaid
nav:
- Introduction:
- General Introduction: index.md
- What is Beacon v2?: what-is-beacon-v2.md
- FAQ: FAQ.md
- Changes: bugs-changes-log.md
- Querying Beacons:
- REST API: rest-api.md
- Genomic Queries: variant-queries.md
- Filters in Queries: /filters/#using-filters-in-queries
- 'Implement & Deploy a Beacon':
- Implementations Options: implementations-options.md
- Standards Integration: formats-standards.md
- Filters: filters.md
- Beacon Implementations:
- Reference Implementation ↗: https://b2ri-documentation.readthedocs.io/en/latest/
- Others: other-implementations.md
- Beacon Types:
- Beacon Flavours: beacon-flavours.md
- Security: security.md
- Networks: networks.md
- Beacon Components:
- Framework: framework.md
- Models:
- Introduction: models.md
- Default 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
- Terms List: schemas-md/beacon_terms.md
- External Links:
- Beacon Project ↗: http://beacon-project.io
- Github Repositories ↗: https://github.com/ga4gh-beacon/
# - Download PDF: pdf/beacon.pdf
theme:
name: material
palette:
primary: teal
logo: img/GA-logo.png
favicon: img/ga4gh_circle.ico
icon:
repo: fontawesome/brands/github-alt
features:
- content.tabs.link
- search.highlight
- search.share
- navigation.instant
- navigation.tracking
- navigation.sections
- toc.integrate
# 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 ...