docusaurus返回siteconfig信息

163 阅读1分钟

根据官方文档提供的示例代码,以下是一些可能的siteConfig信息示例:

import React from 'react';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';

const SiteConfigInfo = () => {
  const { siteConfig } = useDocusaurusContext();
  const { title, tagline, baseUrl, favicon } = siteConfig;

  return (
    <div>
      <h2>Site Config Information:</h2>
      <ul>
        <li>
          <strong>Title:</strong> {title}
        </li>
        <li>
          <strong>Tagline:</strong> {tagline}
        </li>
        <li>
          <strong>Base URL:</strong> {baseUrl}
        </li>
        <li>
          <strong>Favicon:</strong> {favicon}
        </li>
        {/* 添加其他您想要返回的siteConfig信息 */}
      </ul>
    </div>
  );
};

export default SiteConfigInfo;

在上面的代码中,我们从siteConfig对象中提取了一些常见的字段:

  • title:网站的标题。
  • tagline:网站的标语或副标题。
  • baseUrl:网站的根URL。
  • favicon:网站的favicon图标URL。

您可以根据需要自由添加、修改或删除这些字段,并根据您的站点配置使用其他可用的字段。

确保将上述代码保存为一个组件文件(例如SiteConfigInfo.js),然后在需要的地方使用它。例如,在MDX文件中:

mdx

Copy

---
title: 使用 SiteConfigInfo 组件
---

<SiteConfigInfo />

这将在页面上显示站点配置信息的列表,包括标题、标语、根URL和favicon图标URL等。您可以根据需要自定义和展示siteConfig对象的特定字段。