7.34.5 • Published 3 years ago

@arcblock/gatsby-theme-docs v7.34.5

Weekly downloads
801
License
-
Repository
-
Last release
3 years ago

@arcblock/gatsby-theme-docs

This is an entirely configuration-based Gatsby theme that generates a documentation website based on a series of markdown files.

Table of contents

Installation

npm install gatsby @arcblock/gatsby-theme-docs

Configuration

// gatsby-node.js
require('dotenv').config();

const path = require('path');

if (
  !process.env.GATSBY_ALGOLIA_APP_ID ||
  !process.env.GATSBY_ALGOLIA_SEARCH_KEY ||
  !process.env.GATSBY_ALGOLIA_ADMIN_KEY ||
  !process.env.GATSBY_ALGOLIA_INDEX_NAME
) {
  throw new Error('@arcblock/gatsby-theme-docs requires valid algolia search config to work');
}

module.exports = {
  plugins: [
    {
      resolve: require.resolve('@arcblock/www'),
    },
    {
      resolve: require.resolve('@arcblock/gatsby-theme-docs'),
      options: {
        version: 'v0.36.1',
        sourceDirs: [
          path.resolve(__dirname, 'src', 'docs'),
          path.resolve(__dirname, 'src', 'tutorials'),
          path.resolve(__dirname, 'src', 'pages'),
        ],
        siteMetadata: {
          title: 'ArcBlock Docs',
          description: 'Forge SDK Documentation',
        },
        algoliaSearch: {
          enabled: true,
          appId: process.env.GATSBY_ALGOLIA_APP_ID,
          adminKey: process.env.GATSBY_ALGOLIA_ADMIN_KEY,
          searchKey: process.env.GATSBY_ALGOLIA_SEARCH_KEY,
          indexName: process.env.GATSBY_ALGOLIA_INDEX_NAME,
        },
        navItems: [
          {
            title: 'Versions',
            link: '/versions',
            subPages: {
              'https://github.com/ArcBlock': 'v0.36.1',
              'https://www.arcblock.io': 'v0.35.0',
            },
          },
          {
            title: 'Community',
            link: '/community',
            subPages: {
              'https://github.com/ArcBlock': 'GitHub',
              'https://www.arcblock.io': 'About',
              // 'https://gitter.im/ArcBlock/community': 'Gitter',
              'https://community.arcblockio.cn': 'Community',
              'https://twitter.com/ArcBlock_io': 'Twitter',
              'https://youtube.com/channel/UC0pEW_GOrMJ23l8QcrGdKSw': 'YouTube',
            },
          },
        ],
        maxImageWidth: 1000,
        extraPlugins: [],
      },
    },
  ],
};

Login Support

This theme has built-in support for DID:Connect service powered login.

Just set GATSBY_DID_CONNECT_APP_DID and GATSBY_DID_CONNECT_SERVICE in your config file, everything should work.

Sample Config

GATSBY_ALGOLIA_APP_ID="FU81LCBN51"                                  # required to init algolia
GATSBY_ALGOLIA_ADMIN_KEY="7eec833"                                  # required to update index on algolia search
GATSBY_ALGOLIA_SEARCH_KEY="2e4d21878c80877e1"                       # required to enable search on algolia
GATSBY_ALGOLIA_INDEX_NAME="forge-cli-handbook"
GATSBY_DID_CONNECT_APP_DID="zNKfp1scmdbfedSe9Vch2fhGiA8TK9r7fL9Z"
GATSBY_DID_CONNECT_SERVICE="https://connect.wallet.arcblockio.cn"
7.34.5

3 years ago

7.34.4

4 years ago

7.34.3

4 years ago

7.34.2

4 years ago

7.34.1

4 years ago

7.34.0

4 years ago

7.33.8

4 years ago

7.33.9

4 years ago

7.33.7

4 years ago

7.33.6

4 years ago

7.33.5

4 years ago

7.33.4

4 years ago

7.33.3

4 years ago

7.33.2

5 years ago

7.33.1

5 years ago

7.33.0

5 years ago

7.32.0

5 years ago

7.30.0

5 years ago

7.28.20

5 years ago

7.28.21

5 years ago

7.28.19

5 years ago

7.28.18

5 years ago

7.28.17

5 years ago

7.28.16

5 years ago

7.28.15

5 years ago

7.28.14

5 years ago

7.28.13

5 years ago

7.28.12

5 years ago

7.28.11

5 years ago

7.28.10

5 years ago

7.28.9

5 years ago

7.28.8

5 years ago

7.28.7

5 years ago

7.28.6

5 years ago

7.28.5

5 years ago

7.28.4

5 years ago

7.28.3

5 years ago

7.28.2

5 years ago

7.28.1

5 years ago

7.28.0

5 years ago

7.27.1

5 years ago

7.27.0

5 years ago

7.27.2

5 years ago

7.26.2

5 years ago

7.26.1

5 years ago

7.26.0

5 years ago

7.25.3

5 years ago

7.25.2

5 years ago

7.25.1

5 years ago

7.25.0

5 years ago

7.24.8

5 years ago

7.24.7

5 years ago

7.24.6

5 years ago

7.24.5

5 years ago

7.24.4

5 years ago

7.24.3

5 years ago

7.24.2

5 years ago

7.24.1

5 years ago

7.24.0

5 years ago

7.23.0

5 years ago

7.22.2

5 years ago

7.22.0

5 years ago

7.21.0

5 years ago

7.20.0

5 years ago

7.19.3

5 years ago

7.19.1

5 years ago

7.19.2

5 years ago

7.19.0

5 years ago

7.18.0

5 years ago

7.17.1

5 years ago

7.17.0

5 years ago

7.16.0

5 years ago

7.16.1

5 years ago

7.15.2

5 years ago

7.15.1

5 years ago

7.15.0

5 years ago

7.14.0

5 years ago

7.13.0

5 years ago

7.12.0

5 years ago

7.11.3

5 years ago

7.11.1

5 years ago

7.11.2

5 years ago

7.11.0

5 years ago

7.10.0

5 years ago

7.9.0

5 years ago

7.8.0

5 years ago

7.7.0

5 years ago

7.5.10

5 years ago

7.5.11

5 years ago

7.5.9

5 years ago

7.5.6

5 years ago

7.5.3

5 years ago

7.5.5

5 years ago

7.5.1

5 years ago

7.4.4

5 years ago

7.4.3

5 years ago

7.4.2

5 years ago

7.4.0

5 years ago

7.3.0

5 years ago

7.2.8

5 years ago

7.2.7

5 years ago

7.2.6

5 years ago

7.2.5

5 years ago

7.2.4

5 years ago

7.2.3

5 years ago

7.2.2

5 years ago

7.2.0

5 years ago

7.0.0

5 years ago

7.1.0

5 years ago

6.97.0

5 years ago

6.99.0

5 years ago

6.98.0

5 years ago

6.93.0

5 years ago

6.96.0

5 years ago

6.94.0

5 years ago

6.92.0

5 years ago

6.91.0

5 years ago

6.89.0

5 years ago

6.90.0

5 years ago

6.88.0

5 years ago

6.78.2

5 years ago

6.87.0

5 years ago

6.86.0

5 years ago

6.85.0

5 years ago

6.84.0

5 years ago

6.83.0

5 years ago

6.82.0

5 years ago

6.81.0

5 years ago

6.80.0

5 years ago

6.78.0

5 years ago

6.79.0

5 years ago

6.76.0

5 years ago

6.75.0

5 years ago

6.72.0

5 years ago

6.74.0

5 years ago

6.73.0

5 years ago

6.71.0

5 years ago

6.69.0

6 years ago

6.68.0

6 years ago

6.67.0

6 years ago

6.66.0

6 years ago

6.65.0

6 years ago

6.64.0

6 years ago

6.63.0

6 years ago

6.62.0

6 years ago

6.61.0

6 years ago

6.59.0

6 years ago

6.58.0

6 years ago

6.53.0

6 years ago

6.55.0

6 years ago

6.54.0

6 years ago

6.56.0

6 years ago

6.52.0

6 years ago

6.51.0

6 years ago

6.49.0

6 years ago

6.50.0

6 years ago

6.48.0

6 years ago

6.47.0

6 years ago

6.45.0

6 years ago

6.46.0

6 years ago

6.44.0

6 years ago

6.43.0

6 years ago

6.42.0

6 years ago

6.41.0

6 years ago

6.40.0

6 years ago

6.39.0

6 years ago

6.38.0

6 years ago

6.37.0

6 years ago

6.36.0

6 years ago

6.35.0

6 years ago

6.34.0

6 years ago

6.33.0

6 years ago

6.32.0

6 years ago

6.31.0

6 years ago

6.30.0

6 years ago

6.29.0

6 years ago

6.28.0

6 years ago

6.27.0

6 years ago

6.26.0

6 years ago

6.25.0

6 years ago

6.24.0

6 years ago

6.23.0

6 years ago

6.22.0

6 years ago

6.21.0

6 years ago

6.19.0

6 years ago

6.18.0

6 years ago

6.17.0

6 years ago

6.15.0

6 years ago

6.14.0

6 years ago

6.13.0

6 years ago

6.12.0

6 years ago

6.11.0

6 years ago

6.10.0

6 years ago

6.9.0

6 years ago

6.8.0

6 years ago

6.7.0

6 years ago

6.6.0

6 years ago

6.5.0

6 years ago

6.4.0

6 years ago

6.3.0

6 years ago

6.2.0

6 years ago

6.1.0

6 years ago

6.0.0

6 years ago

5.12.0

6 years ago

5.9.0

6 years ago

5.8.0

6 years ago

5.7.0

6 years ago