ldo.js.org/mkdocs.yml at main · o-development/ldo.js.org · GitHub

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
133
134
135
136
137
138
139
140
141
142
143
144
site_name: Linked Data Objects (LDO)
site_url: https://ldo.js.org
repo_url: https://github.com/o-development/ldo
copyright: Copyright &copy; 2025 Jackson Morgan
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - attr_list
nav:
  - Guides:
    - 'guides/index.md'
    - For Raw Rdf: guides/raw_rdf/index.md
    - For Solid: guides/solid/index.md
    - For NextGraph: guides/nextgraph/index.md
    - For Solid+React: guides/solid_react/index.md
    - Advanced Data Manipulation:
      - guides/advanced_data_manipulation/index.md
  - API:
    - 'api/index.md'
    - '@ldo/cli':
      - 'api/cli/index.md'
      - init: 'api/cli/init.md'
      - build: 'api/cli/build.md'
      - create: 'api/cli/create.md'
    - '@ldo/ldo':
      - 'api/ldo/index.md'
      - LdoBase: 'api/ldo/LdoBase.md'
      - ShapeType: 'api/ldo/ShapeType.md'
      - parseRdf: 'api/ldo/parseRdf.md'
      - createLdoDatasetFactory: 'api/ldo/createLdoDatasetFactory.md'
      - LdoDatasetFactory: 'api/ldo/LdoDatasetFactory.md'
      - createLdoDataset: 'api/ldo/createLdoDataset.md'
      - LdoDataset: 'api/ldo/LdoDataset.md'
      - LdoBuilder: 'api/ldo/LdoBuilder.md'
      - toTurtle: 'api/ldo/toTurtle.md'
      - toNTriples: 'api/ldo/toNTriples.md'
      - serialize: 'api/ldo/serialize.md'
      - transactions: 'api/ldo/transactions.md'
      - toSparqlUpdate: 'api/ldo/toSparqlUpdate.md'
      - languageOf: 'api/ldo/languageOf.md'
      - setLanguagePreferences: 'api/ldo/setLanguagePreferences.md'
      - graphOf: 'api/ldo/graphOf.md'
      - write: 'api/ldo/write.md'
      - getDataset: 'api/ldo/getDataset.md'
    - '@ldo/connected':
      - 'api/connected/README.md'
      - createConnectedLdoDataset: 'api/connected/functions/createConnectedLdoDataset.md'
      - ConnectedLdoDataset: 'api/connected/classes/ConnectedLdoDataset.md'
      - ConnectedLdoTransactionDataset: 'api/connected/classes/ConnectedLdoTransactionDataset.md'
      - ConnectedLdoBuilder: 'api/connected/classes/ConnectedLdoBuilder.md'
      - IConnectedLdoDataset: 'api/connected/interfaces/IConnectedLdoDataset.md'
      - ConnectedPlugin: 'api/connected/interfaces/ConnectedPlugin.md'
      - Resource: 'api/connected/interfaces/Resource.md'
      - changeData: 'api/connected/functions/changeData/'
      - commitData: 'api/connected/functions/commitData/'
      - SuccessResult: 'api/connected/classes/SuccessResult.md'
      - AbsentReadSuccess: 'api/connected/classes/AbsentReadSuccess.md'
      - AggregateSuccess: 'api/connected/classes/AggregateSuccess.md'
      - IgnoredInvalidUpdateSuccess: 'api/connected/classes/IgnoredInvalidUpdateSuccess.md'
      - ReadSuccess: 'api/connected/classes/ReadSuccess.md'
      - ResourceSuccess: 'api/connected/classes/ResourceSuccess.md'
      - Unfetched: 'api/connected/classes/Unfetched.md'
      - UpdateDefaultGraphSuccess: 'api/connected/classes/UpdateDefaultGraphSuccess.md'
      - UpdateSuccess: 'api/connected/classes/UpdateSuccess.md'
      - ErrorResult: 'api/connected/classes/ErrorResult.md'
      - AggregateError: 'api/connected/classes/AggregateError.md'
      - DisconnectedAttemptingReconnectError: 'api/connected/classes/DisconnectedAttemptingReconnectError.md'
      - InvalidUriError: 'api/connected/classes/InvalidUriError.md'
      - ResourceError: 'api/connected/classes/ResourceError.md'
      - UnexpectedResourceError: 'api/connected/classes/UnexpectedResourceError.md'
      - UnsupportedNotificationError: 'api/connected/classes/UnsupportedNotificationError.md'
    - '@ldo/connected-solid':
      - 'api/connected-solid/README.md'
      - createSolidLdoDataset: 'api/connected-solid/functions/createSolidLdoDataset.md'
      - SolidResource: 'api/connected-solid/classes/SolidResource.md'
      - SolidLeafUri: 'api/connected-solid/types/SolidLeafUri.md'
      - SolidContainerUri: 'api/connected-solid/types/SolidContainerUri.md'
      - SolidLeaf: 'api/connected-solid/classes/SolidLeaf.md'
      - SolidContainer: 'api/connected-solid/classes/SolidContainer.md'
    - '@ldo/solid-react':
      - 'api/solid-react/index.md'
      - BrowserSolidLdoProvider: 'api/solid-react/BrowserSolidLdoProvider.md'
      - SolidLdoProvider: 'api/solid-react/SolidLdoProvider.md'
      - useLdo: 'api/solid-react/useLdo.md'
      - useResource: 'api/solid-react/useResource.md'
      - useRootContainer: 'api/solid-react/useRootContainer.md'
      - useSolidAuth: 'api/solid-react/useSolidAuth.md'
      - useSubject: 'api/solid-react/useSubject.md'
      - useMatchSubject: 'api/solid-react/useMatchSubject.md'
      - useMatchObject: 'api/solid-react/useMatchObject.md'
      - useSubscribeToResource: 'api/solid-react/useSubscribeToResource.md'
      - useLinkQuery: 'api/solid-react/useLinkQuery.md'
      - useChangeDataset: 'api/solid-react/useChangeDataset.md'
      - useChangeSubject: 'api/solid-react/useChangeSubject'
      - useChangeMatchSubject: 'api/solid-react/useChangeMatchSubject'
      - useChangeMatchObject: 'api/solid-react/useChangeMatchObject'

    # - '@ldo/jsonld-dataset-proxy': 'api/jsonld-dataset-proxy/index.md'
    # - '@ldo/dataset': 'api/dataset/index.md'
    # - '@ldo/subscribable-dataset': 'api/subscribable-dataset/index.md'
    # - '@ldo/schema-converter-shex': 'api/schema-converter-shex/index.md'
    # - '@ldo/traverser-shexj': 'api/traverser-shexj/index.md'
    # - '@ldo/type-traverser': 'api/type-traverser/index.md'
    # - '@ldo/rdf-utils': 'api/rdf-utils/index.md'
  - Blog:
    - blog/index.md
theme:
    name: material
    custom_dir: overrides
    logo: assets/Logo-40.png
    language: en
    favicon: assets/favicon.png
    palette:
      scheme: slate
      primary: black
    features:
      - navigation.instant
      - navigation.tracking
      - navigation.sections
      - navigation.indexes
      - navigation.footer
      - toc.follow
      - search.suggest
      - search.highlight
plugins:
  - mike:
      # These fields are all optional; the defaults are as below...
      alias_type: symlink
      redirect_template: null
      deploy_prefix: ''
      canonical_version: null
      version_selector: true
      css_dir: css
      javascript_dir: js
  - blog
extra:
  version:
    provider: mike
    current: 1.0.0-alpha.X