/ website / siteConfig.js
siteConfig.js
 1  /**
 2   * Copyright (c) 2017-present, Facebook, Inc.
 3   *
 4   * This source code is licensed under the MIT license found in the
 5   * LICENSE file in the root directory of this source tree.
 6   */
 7  
 8  // See https://docusaurus.io/docs/site-config.html for all the possible
 9  // site configuration options.
10  
11  /* List of projects/orgs using your project for the users page */
12  const users = [
13    {
14      caption: 'User1',
15      image: '/test-site/img/docusaurus.svg',
16      infoLink: 'https://www.facebook.com',
17      pinned: true,
18    },
19  ];
20  
21  const siteConfig = {
22    title: 'Test Site' /* title for your website */,
23    tagline: 'A website for testing',
24    url: 'http://status-im.github.io/docs/' /* your website url */,
25    baseUrl: '/docs/' /* base url for your project */,
26    // For github.io type URLs, you would set the url and baseUrl like:
27    //   url: 'https://facebook.github.io',
28    //   baseUrl: '/test-site/',
29  
30    // Used for publishing and more
31    projectName: 'docs',
32    organizationName: 'status-im',
33    // For top-level user or org sites, the organization is still the same.
34    // e.g., for the https://JoelMarcey.github.io site, it would be set like...
35    //   organizationName: 'JoelMarcey'
36  
37    // For no header links in the top nav bar -> headerLinks: [],
38    headerLinks: [
39      {doc: 'doc1', label: 'Docs'},
40      {doc: 'doc4', label: 'API'},
41      {page: 'help', label: 'Help'},
42      {blog: true, label: 'Blog'},
43    ],
44  
45    // If you have users set above, you add it here:
46    users,
47  
48    /* path to images for header/footer */
49    headerIcon: 'img/docusaurus.svg',
50    footerIcon: 'img/docusaurus.svg',
51    favicon: 'img/favicon.png',
52  
53    /* colors for website */
54    colors: {
55      primaryColor: '#2E8555',
56      secondaryColor: '#205C3B',
57    },
58  
59    /* custom fonts for website */
60    /*fonts: {
61      myFont: [
62        "Times New Roman",
63        "Serif"
64      ],
65      myOtherFont: [
66        "-apple-system",
67        "system-ui"
68      ]
69    },*/
70  
71    // This copyright info is used in /core/Footer.js and blog rss/atom feeds.
72    copyright:
73      'Copyright © ' +
74      new Date().getFullYear() +
75      ' Your Name or Your Company Name',
76  
77    highlight: {
78      // Highlight.js theme to use for syntax highlighting in code blocks
79      theme: 'default',
80    },
81  
82    // Add custom scripts here that would be placed in <script> tags
83    scripts: ['https://buttons.github.io/buttons.js'],
84  
85    /* On page navigation for the current documentation page */
86    onPageNav: 'separate',
87  
88    /* Open Graph and Twitter card images */
89    ogImage: 'img/docusaurus.png',
90    twitterImage: 'img/docusaurus.png',
91  
92    // You may provide arbitrary config keys to be used as needed by your
93    // template. For example, if you need your repo's URL...
94    //   repoUrl: 'https://github.com/facebook/test-site',
95  };
96  
97  module.exports = siteConfig;