docs/mkdocs.yml at main · feral-file/docs · 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
site_name: Feral File Docs
site_url: https://docs.feralfile.com
repo_url: https://github.com/feral-file/docs
theme:
  name: material

extra_javascript:
  - https://unpkg.com/mermaid@10.6.1/dist/mermaid.min.js

extra_css:
  - https://unpkg.com/mermaid@10.6.1/dist/mermaid.min.css
nav:
  - Home: index.md
  - FF1 CLI:
    - Start Here: api-reference/cli.md
  - FF1:
    - Getting Started: ff1/index.md
    - How It Works:
      - Life Cycle: ff1/how-it-works/life-cycle.md
      - End-to-End Architecture: ff1/how-it-works/display.md
      - Send Playlists to FF1: ff1/how-it-works/send-playlists-to-ff1.md
      - OTA: ff1/how-it-works/ota.md
    - Specification: ff1/specification.md
  - Exhibitions & Archive:
    - Exhibition Structure: exhibitions-n-archive/exhibition-structure.md
    - Modeling Artworks: exhibitions-n-archive/modeling-work.md
    - Token Metadata: exhibitions-n-archive/token-metadata.md
    - Smart Contracts: exhibitions-n-archive/smart-contracts.md
    - Data Endpoints: exhibitions-n-archive/data-endpoints.md
  - Artwork Library (JavaScript):
    - Install & Basics: artwork-lib/install-basics.md
    - Event Listeners: artwork-lib/event-listeners.md
  - DP-1 Protocol:
    - Start Here (Integrators): dp1-protocol/overview.md
    - Validator Quickstart: dp1-protocol/validator.md
    - Schemas: dp1-protocol/schemas.md
    - Feed Server:
      - Hosted Feed (Feral File): dp1-protocol/feed-server.md
      - Run your own Feed Server: dp1-protocol/self-hosted-feed.md
    - FF1 Playback Bridge: dp1-protocol/ff1-integration.md
    - Player Behavior: dp1-protocol/player-behavior.md
  - API Reference:
    - Command API: api-reference/command-api.md
    - Webhooks: api-reference/webhooks.md
  - LLM & Agents:
    - Quickstart: llm-agents/quickstart.md
  - Architecture:
    - Overview: bands/overview.md
  - Changelog: changelog.md
  - Contribute: contribute.md
  - FAQ: faq.md

markdown_extensions:
  - admonition
  - attr_list
  - footnotes
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.details
  - pymdownx.tabbed