forest-filecoin 0.33.2

Rust Filecoin implementation.
Documentation 
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
118
119
120
121
122
123
124
125
126
127
128
129
130

// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

const lightCodeTheme = require("prism-react-renderer").themes.github;
const darkCodeTheme = require("prism-react-renderer").themes.dracula;

/** @type {import('@docusaurus/mdx-loader').MDXPlugin} */
// @ts-ignore
const mermaidPlugin = require("mdx-mermaid");

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "Forest Docs",
  tagline: "Filecoin Rust Implementation",
  url: "https://forest.chainsafe.io",
  baseUrl: "/",
  onBrokenLinks: "throw",
  onBrokenAnchors: "throw",
  favicon: "img/logo.png",
  organizationName: "ChainSafe", // Usually your GitHub org/user name.
  projectName: "forest", // Usually your repo name.

  presets: [
    [
      "@docusaurus/preset-classic",
      /** @type {import("@docusaurus/preset-classic").Options} */
      ({
        blog: false,
        pages: false,
        docs: {
          id: "userDocs",
          routeBasePath: "/",
          path: "docs/users",
          sidebarPath: require.resolve("./userSidebars.js"),
          editUrl: "https://github.com/chainsafe/forest",
          remarkPlugins: [mermaidPlugin],
        },
        theme: {
          customCss: require.resolve("./src/css/index.css"),
        },
      }),
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      colorMode: {
        defaultMode: "dark",
        disableSwitch: true,
        respectPrefersColorScheme: false,
      },
      navbar: {
        title: "Forest Docs",
        hideOnScroll: true,
        logo: {
          alt: "Forest Logo",
          src: "img/logo.png",
        },
        items: [
          {
            href: "https://github.com/chainsafe/forest",
            label: "GitHub",
            position: "right",
          },
        ],
      },
      docs: {
        sidebar: {
          hideable: true,
        },
      },
      footer: {
        style: "dark",
        links: [],
        copyright: `Copyright © ${new Date().getFullYear()} ChainSafe. Built with Docusaurus.`,
      },
      prism: {
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
      },
    }),
  plugins: [
    [
      "@docusaurus/plugin-content-docs",
      {
        id: "devDocs",
        routeBasePath: "developers",
        path: "docs/developers",
        sidebarPath: require.resolve("./devSidebars.js"),
        editUrl: "https://github.com/chainsafe/forest",
        remarkPlugins: [mermaidPlugin],
        showLastUpdateTime: true,
        showLastUpdateAuthor: true,
      },
    ],
  ],
  markdown: {
    mermaid: true,
    hooks: {
      onBrokenMarkdownLinks: "throw",
    },
  },
  themes: [
    [
      "@easyops-cn/docusaurus-search-local",
      /** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
      {
        hashed: true,
        highlightSearchTermsOnTargetPage: true,
        docsRouteBasePath: ["/", "developers"],
        docsDir: ["docs/users", "docs/developers"],
        docsPluginIdForPreferredVersion: "userDocs",
        searchContextByPaths: [
          {
            label: "Users",
            path: "/",
          },
          {
            label: "Devs",
            path: "developers",
          },
        ],
      },
    ],
    ["@docusaurus/theme-mermaid", {}],
  ],
};

module.exports = config;