forked from ceramicnetwork/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
132 lines (123 loc) · 3.98 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
123
124
125
126
127
128
129
130
131
132
site_name: Ceramic Developers
site_url: https://developers.ceramic.network
site_description: Specs, docs, guides, and APIs for the Ceramic Network.
repo_url: https://github.com/ceramicnetwork/js-ceramic
repo_name: ceramicnetwork/js-ceramic
edit_uri: https://github.com/ceramicnetwork/docs/edit/main/docs/
# Copyright
copyright: 'Ceramic is open sourced under MIT and Apache 2'
theme:
name: material
custom_dir: overrides
# 404 page
static_templates:
- 404.html
palette:
scheme: default
logo: images/ceramic-no-shadow.png
icon:
repo: fontawesome/brands/github-alt
favicon: images/favicon.png
features:
- navigation.instant
- navigation.tabs
- navigation.expand
- navigation.sections
- header.autohide
nav:
#- Learn:
#- Overview: learn/overview.md
#- Documents: learn/documents/document-model.md
#- Network:
#- Nodes: learn/network/nodes.md
#- Clients: learn/network/clients.md
#- Anchor Services: learn/network/anchor-services.md
#- DIDs:
#- learn/dids/specification.md
#- learn/dids/methods.md
#- learn/dids/resolvers.md
#- learn/dids/providers.md
#- learn/dids/wallets.md
- Build:
- Quick Start: build/quick-start.md
- Installation: build/installation.md
- Authentication: build/authentication.md
- Writes: build/writes.md
- Queries: build/queries.md
- Pinning: build/pinning.md
- Share your work: build/share.md
- Troubleshooting: build/troubleshooting.md
#- Run:
#- Running a node: run/running-a-node.md
#- Running an anchor service: run/running-an-anchor-service.md
#- Deployment tools: run/deployment-tools.md
#- Tools:
#- Networks: tools/networks.md
#- Clients:
#- HTTP Client: tools/clients/http.md
#- Core Client: tools/clients/core.md
#- CLI: tools/clients/cli.md
#- DIDs:
#- 3ID DID Method: tools/dids/3id-did.md
#- Key DID Method: tools/dids/key-did.md
#- Doctypes:
#- Tile: tools/doctypes/tile.md
#- CAIP-10 Link: tools/doctypes/caip-10-link.md
#- Identity:
#- IDX: tools/identity/idx.md
#- Self.id: tools/identity/self-id.md
#- Development:
#- Clayground: tools/development/clayground.md
#- Hosting:
#- Community gateway: tools/hosting/community-gateway.md
#- Community dev node: tools/hosting/community-dev-node.md
#- Community anchor service: tools/hosting/community-anchor-service.md
#- Hosting providers: tools/hosting/hosting-providers.md
- Reference:
- JavaScript:
- Clients: reference/javascript/clients.md
- DID Resolvers: reference/javascript/did-resolvers.md
- DID Providers: reference/javascript/did-providers.md
#- Doctypes:
#- ceramicnetwork/doctype-tile: tools/hosting/hosting-providers.md
#- ceramicnetwork/doctype-caip-10-link: tools/hosting/hosting-providers.md
- Anchor Service: reference/javascript/anchor-service.md
- HTTP API: reference/http-api.md
- Chat: 'https://chat.ceramic.network'
- Blog: 'https://blog.ceramic.network'
markdown_extensions:
- meta
- pymdownx.tabbed
- pymdownx.superfences
- admonition
- pymdownx.details
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.betterem:
smart_enable: all
- pymdownx.smartsymbols
- toc:
permalink: true
toc_depth: 3
extra:
generator: false
# Social icons in footer
social:
- icon: fontawesome/brands/github
link: https://github.com/ceramicnetwork/ceramic
name: Ceramicnetwork on Github
- icon: fontawesome/brands/twitter
link: https://twitter.com/ceramicnetwork
name: Ceramicnetwork on Twitter
extra_javascript:
- https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
- javascripts/tables.js
extra_css:
- stylesheets/extra.css
plugins:
- redirects:
redirect_maps:
'index.md': 'build/quick-start.md'
- search