config.js 5.72 KB
Newer Older
1 2 3 4
const { description } = require('../../package')
const path = require('path')

module.exports = {
5
  title: 'OP Stack Docs',
6
  description: description,
7
  head: [
8 9 10 11
    ['link', { rel: 'manifest', href: '/manifest.json' }],
    ['meta', { name: 'theme-color', content: '#3eaf7c' }],
    ['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
    ['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }],
Ori Pomerantz's avatar
Ori Pomerantz committed
12
    ['meta', { property: 'og:image', content: 'https://stack.optimism.io/assets/logos/twitter-logo.png' }],
Ori Pomerantz's avatar
Ori Pomerantz committed
13
    ['meta', { name: 'twitter:image', content: 'https://stack.optimism.io/assets/logos/twitter-logo.png' }],
14 15
    ['meta', { name: 'twitter:title', content: 'OP Stack Docs' }],
    ['meta', { property: 'og:title', content: 'OP Stack Docs' }],
Ori Pomerantz's avatar
Ori Pomerantz committed
16
    ['meta', { name: 'twitter:card', content: 'summary' } ],
17 18 19 20
    ['link', { rel: "icon", type: "image/png", sizes: "32x32", href: "/assets/logos/favicon.png"}],
  ],
  theme: path.resolve(__dirname, './theme'),
  themeConfig: {
Ori Pomerantz's avatar
Ori Pomerantz committed
21
    "twitter:card": "summary",
22
    contributor: false,
Ori Pomerantz's avatar
Ori Pomerantz committed
23
    hostname: 'https://stack.optimism.io',
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
    logo: '/assets/logos/logo.png',
    docsDir: 'src',
    docsRepo: 'https://github.com/ethereum-optimism/opstack-docs',
    docsBranch: 'main',
    lastUpdated: false,
    darkmode: 'disable',
    themeColor: false,
    blog: false,
    iconPrefix: 'far fa-',
    pageInfo: false,
    pwa: {
      cacheHTML: false,
    },
    activeHash: {
      offset: -200,
    },
    algolia: {
41 42
      appId: '7Q6XITDI0Z',
      apiKey: '9d55a31a04b210cd26f97deabd161705',
43 44
      indexName: 'optimism'
    },
45
    nav: [
46
      {
47 48
        text: 'Home',
        link: 'https://www.optimism.io/'
49
      },
50
      {
51
        text: 'OP Stack Docs',
52
        link: '/'
53 54
      },
      {
55 56
        text: 'Optimism Docs',
        link: 'https://community.optimism.io/'
57 58
      },
      {
59 60
        text: 'Governance',
        link: 'https://community.optimism.io/docs/governance/'
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
      },
      {
        text: 'Community',
        items: [
          {
            icon: 'discord',
            iconPrefix: 'fab fa-',
            iconClass: 'color-discord',
            text: 'Discord',
            link: 'https://discord.optimism.io',
          },
          {
            icon: 'github',
            iconPrefix: 'fab fa-',
            iconClass: 'color-github',
            text: 'GitHub',
            link: 'https://github.com/ethereum-optimism/optimism',
          },
          {
            icon: 'twitter',
            iconPrefix: 'fab fa-',
            iconClass: 'color-twitter',
            text: 'Twitter',
            link: 'https://twitter.com/optimismFND',
          },
          {
            icon: 'twitch',
            iconPrefix: 'fab fa-',
            iconClass: 'color-twitch',
            text: 'Twitch',
            link: 'https://www.twitch.tv/optimismpbc'
          },
          {
            icon: 'medium',
            iconPrefix: 'fab fa-',
            iconClass: 'color-medium',
            text: 'Blog',
            link: 'https://optimismpbc.medium.com/'
          },
          {
            icon: 'computer-classic',
            iconClass: 'color-ecosystem',
            text: 'Ecosystem',
            link: 'https://www.optimism.io/apps/all',
          },
          {
            icon: 'globe',
            iconClass: 'color-optimism',
            text: 'optimism.io',
            link: 'https://www.optimism.io/',
          }
        ]
      }
114
    ],
115
    searchPlaceholder: 'Search the docs',
116 117 118 119 120
    sidebar: [
      {
        title: "OP Stack",
        collapsable: false,
        children: [        
121 122 123 124 125 126 127
          '/',
          [
            '/docs/understand/design-principles.md',
            'Design Principles'
          ],
          '/docs/understand/landscape.md',
          '/docs/understand/explainer.md'
128 129 130 131
        ]
      }, 
      {
        title: "Releases",
132
        collapsable: false,
133 134
        children: [
          '/docs/releases/',
135 136 137 138 139
          {
            title: "Bedrock",
            collapsable: true,
            children: [
              '/docs/releases/bedrock/',
140
              '/docs/releases/bedrock/explainer.md',
141 142 143
              '/docs/releases/bedrock/differences.md'
            ]
          }
144 145 146 147 148 149 150 151
        ]
      },
      {
        title: "Building OP Stack Rollups",
        collapsable: false,
        children: [
          '/docs/build/getting-started.md',
          '/docs/build/conf.md',
152
          '/docs/build/explorer.md',
153 154 155 156 157 158
          {
            title: "OP Stack Hacks",
            collapsable: true,
            children: [
              '/docs/build/hacks.md',
              '/docs/build/featured.md',
159
              '/docs/build/data-avail.md',
160 161
              '/docs/build/derivation.md',
              '/docs/build/execution.md',
162
              '/docs/build/settlement.md',
163 164 165 166 167 168 169 170 171 172 173
              {
                title: "Sample Hacks",
                children: [
                  "/docs/build/tutorials/add-attr.md",
                  "/docs/build/tutorials/new-precomp.md",                
                ]
              }  // End of tutorials                      
            ], 
          },    // End of OP Stack hacks
        ],
      },      // End of Building OP Stack Rollups
174 175
      {
        title: "Contributing",
176
        collapsable: false,
177 178
        children: [
          '/docs/contribute.md',
179 180
        ]
      },
181 182
      {
        title: "Security",
183
        collapsable: false,
184 185 186 187 188 189
        children: [
          '/docs/security/faq.md',
          '/docs/security/policy.md',
        ]
      },        
    ],  // end of sidebar
190 191 192 193 194 195 196 197
  plugins: [
    "@vuepress/pwa",
    [
      '@vuepress/plugin-medium-zoom',
      {
        selector: ':not(a) > img'
      }
    ],
198
    "plausible-analytics"
199 200
  ]
}
201
}
202

203
// module.exports.themeConfig.sidebar["/docs/useful-tools/"] = module.exports.themeConfig.sidebar["/docs/developers/"]