docs/app/layout.config.tsx at 67cb2f29507ffdd1804eb3114d294bfadcc354f9 · hirosystems/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
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
import type { BaseLayoutProps } from '@/components/layouts/shared';
/**
 * Shared layout configurations
 *
 * you can customise layouts individually from:
 * Home Layout: app/(home)/layout.tsx
 * Docs Layout: app/docs/layout.tsx
 */
export const baseOptions: BaseLayoutProps = {
  nav: {
    title: 'Hiro Docs',
  },
  links: [
    // {
    //   text: "Get started",
    //   url: "/start",
    //   active: "nested-url",
    // },
    // Menu type - uses NavigationMenu component
    {
      type: 'menu',
      text: 'Tools',
      items: [
        {
          text: 'Chainhook',
          description: 'Monitor and analyze Clarity smart contract activity.',
          url: '/tools/chainhook',
          isBeta: true,
        },
        {
          text: 'Contract Monitoring',
          description: 'Monitor and analyze Clarity smart contract activity.',
          url: '/tools/contract-monitoring',
        },
        {
          text: 'Bitcoin Indexer',
          description: 'Indexer for Bitcoin blockchain data.',
          url: '/tools/bitcoin-indexer',
        },
      ],
    },
    {
      type: 'menu',
      text: 'APIs',
      items: [
        {
          text: 'API keys',
          description: 'API keys for accessing Hiro APIs.',
          url: '/resources/guides/api-keys',
        },
        {
          text: 'Rate limits',
          description: 'Rate limits for accessing Hiro APIs.',
          url: '/resources/guides/rate-limits',
        },
        {
          text: 'Stacks API',
          description: 'RESTful API for accessing Stacks blockchain data and functionality.',
          url: '/apis/stacks-blockchain-api',
        },
        {
          text: 'Stacks RPC Node API',
          description:
            'Raw blockchain node methods: submit txs, call read-only contracts, query mempool/state.',
          url: '/apis/stacks-node-rpc-api',
        },
        {
          text: 'Token Metadata API',
          description: 'API for retrieving NFT and fungible token metadata.',
          url: '/apis/token-metadata-api',
        },
        {
          text: 'Chainhook API',
          description: 'RESTful API for accessing Chainhook',
          url: '/apis/chainhook-api',
          isNew: true,
        },
        {
          text: 'Platform API',
          description: 'API for accessing Hiro Platform data and functionality.',
          url: '/apis/platform-api',
        },
        {
          text: 'Ordinals API',
          description: 'API for Bitcoin Ordinals and inscriptions data.',
          url: '/apis/ordinals-api',
        },
        {
          text: 'Runes API',
          description: 'API for Bitcoin Runes data.',
          url: '/apis/runes-api',
        },
        {
          text: 'Signer Metrics API',
          description: 'API for accessing Signer metrics data and functionality.',
          url: '/apis/signer-metrics-api',
        },
      ],
    },
    {
      type: 'menu',
      text: 'Resources',
      items: [
        {
          text: 'Guides',
          description: 'Guides for building on Stacks.',
          url: '/resources/guides',
        },
        {
          text: 'Hiro Archive',
          description: 'Archive of blockchain data.',
          url: '/resources/archive',
        },
      ],
    },
  ],
};