config.js 5.24 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 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
    ['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' }],
    ['link', { rel: "icon", type: "image/png", sizes: "32x32", href: "/assets/logos/favicon.png"}],
  ],
  theme: path.resolve(__dirname, './theme'),
  themeConfig: {
    contributor: false,
    hostname: 'https://community.optimism.io',
    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: {
      appId: '8LQU4WGQXA',
      apiKey: '2c1a86142192f96dab9a5066ad0c1d50',
      indexName: 'optimism'
    },
39 40
    nav: false, /* [

41
      {
42 43
        text: 'Understanding the OP Stack',
        link: '/docs/understand/'
44
      },
45
      {
46 47
        text: 'Releases',
        link: '/docs/releases/'
48 49
      },
      {
50 51
        text: 'Building',
        link: '/docs/build/'
52 53
      },
      {
54 55
        text: 'Contribute',
        link: '/docs/CONTRIB.md'
56 57
      },
      {
58 59
        text: 'Security',
        link: '/docs/security/'
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
      },
      {
        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/',
          }
        ]
      }
113
    ], */
114
    searchPlaceholder: 'Search the docs',
115
    sidebar: {
116 117 118 119 120 121 122 123 124 125
      '/docs': [
        {
          title: "Understanding the OP Stack",
          collapsable: false,
          children: [        
          '/docs/understand/intro.md',
          '/docs/understand/design-principles.md',
          '/docs/understand/landscape.md',
          ]
        }, 
126
        {
127 128
          title: "Releases",
          collapsable: false,          
129
          children: [
130 131
            '/docs/releases/releases.md',
            '/docs/releases/bedrock.md',
132
          ]
133
        },
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
        {
          title: "Building OP Stack Rollups",
          collapsable: false,
          children: [
            {
              title: "Running a Bedrock Rollup",
              children: [
                '/docs/build/getting-started.md',
                '/docs/build/conf.md'
              ]
            },
            {
              title: "OP Stack Hacks",
              collapsable: true,
              children: [
                '/docs/build/hacks.md',
                '/docs/build/featured.md',
                '/docs/build/data-avail.md',            
                '/docs/build/derivation.md',
                '/docs/build/execution.md',
                '/docs/build/settlement.md',                  
                {
                  title: "Tutorials",
                  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
        '/docs/CONTRIB.md',
        {
          title: "Security",
          collapsable: false,          
          children: [
            '/docs/security/faq.md',
            '/docs/security/policy.md',
          ]
        },        
      ],  // end of '/docs'
    },    // end of sidebar
177 178 179 180 181 182 183 184 185 186 187
  plugins: [
    "@vuepress/pwa",
    [
      '@vuepress/plugin-medium-zoom',
      {
        selector: ':not(a) > img'
      }
    ],
    "plausible-analytics"
  ]
}
188
}
189

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