-
Notifications
You must be signed in to change notification settings - Fork 15
/
Copy pathmkdocs.yml
122 lines (117 loc) · 4 KB
/
mkdocs.yml
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
122
site_name: DANDI Documentation
repo_name: "dandi/dandi-docs"
repo_url: "https://github.com/dandi/dandi-docs"
copyright: "CC-BY 4.0"
use_directory_urls: true
site_url: https://docs.dandiarchive.org
# Material theme
theme:
name: "material"
language: "en"
favicon: img/favicon.ico
logo: img/dandi-logo-square_sw.png
palette:
- scheme: default
toggle:
icon: material/weather-night
name: Dark mode
primary: "dark blue"
accent: "light blue"
- scheme: slate
toggle:
icon: material/weather-sunny
name: Light mode
primary: "dark blue"
accent: "light blue"
features:
- toc.integrate
# Pages
nav:
- Welcome: "index.md"
- Introduction: "01_introduction.md"
- Data Standards: "30_data_standards.md"
- Data Licenses: "35_data_licenses.md"
- User Guide:
- Using DANDI: "10_using_dandi.md"
- Create DANDI Account: "16_account.md"
- Viewing Dandisets: "11_view.md"
- Downloading Data and Dandisets: "12_download.md"
- Creating Dandisets and Uploading Data: "13_upload.md"
- Validation Levels for NWB Files: "135_validation.md"
- Dandiset Metadata: "136_metadata.md"
- Publishing Dandisets: "14_publish.md"
- Citing a Dandiset: "citing.md"
- Debugging: "15_debugging.md"
- DANDI CLI and Python API: https://dandi.readthedocs.io
- Developer Guide:
- Project Structure: "20_project_structure.md"
- Models Integration: "21_models_integration.md"
- Notes: "40_development.md"
- REST API Swagger: https://api.dandiarchive.org/swagger
- REST API Redoc: https://api.dandiarchive.org/redoc
- Create DANDI Instance:
- Overview and Architecture: "59_overview.md"
- Initialize Vendor Accounts for DANDI: "60_initialize_vendors.md"
- DANDI Authentication: "61_dandi_authentication.md"
- DANDI Client: "62_dandi_cli.md"
- DANDI Infrastructure: "63_dandi_infrastructure.md"
- DANDI Archive: "64_dandi_archive.md"
- DANDI Hub: "65_dandi_hub.md"
- Contributing Documentation: "100_contribute_docs.md"
- DANDI Hub: "50_hub.md"
- Tutorials:
- Dandiset Examples: https://dandi.github.io/example-notebooks
- DANDI User Guide, Part I: "example-notebooks/dandi/DANDI User Guide, Part I.ipynb"
- DANDI User Guide, Part II: "example-notebooks/dandi/DANDI User Guide, Part II.ipynb"
- Simple Dandiset Search: "example-notebooks/tutorials/neurodatarehack_2024/simple_dandiset_search.ipynb"
- Advanced Asset Search: "example-notebooks/tutorials/cosyne_2023/advanced_asset_search.ipynb"
- Streaming and interacting with NWB data: "example-notebooks/tutorials/bcm_2024/analysis-demo.ipynb"
- NWB Widget Demo: "example-notebooks/demos/NWBWidget-demo.ipynb"
- Health Status:
- Dandisets: https://github.com/dandi/dandisets-healthstatus
- Services: https://status.dandiarchive.org
- Terms and Policies:
- Terms: "about/terms.md"
- Policies: "about/policies.md"
# List of extensions
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.critic
- pymdownx.magiclink
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- toc:
permalink: True
# List of plugins
plugins:
- search
- open-in-new-tab
- mkdocs-jupyter:
ignore_h1_titles: True
include: ["*.ipynb"]
# Customize theme
extra:
homepage: https://dandiarchive.org
analytics:
provider: google
property: G-15WQLCLQ3L
social:
- icon: fontawesome/brands/slack
link: https://dandiarchive.slack.com
name: Slack
- icon: fontawesome/solid/paper-plane
link: mailto:[email protected]
name: Email
- icon: fontawesome/brands/github
link: https://github.com/dandi
name: GitHub
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/@dandiarchive
name: YouTube
- icon: fontawesome/brands/bluesky
link: https://bsky.app/profile/dandiarchive.org
name: Bluesky