侧边栏壁纸
  • 累计撰写 88 篇文章
  • 累计创建 21 个标签
  • 累计收到 4 条评论

目 录CONTENT

文章目录

Docusaurus 快速使用

心生向往
2024-12-27 / 0 评论 / 0 点赞 / 21 阅读 / 309 字

开始上手

npx create-docusaurus@latest my-website classic
cd my-website
npx docusaurus start

配置

docusaurus.config.js

  • Site metadata
    站点元数据包含基本的全局元数据,如 title、url、baseUrl 和 favicon。它们用于多个地方,例如您网站的标题和标题、浏览器选项卡图标、社交共享(Facebook、X)信息,甚至用于生成正确的路径来提供您的静态文件
  • Deployment configurations
    用来配置项目名称,组织名称等 详细配置
  • Theme, plugin, and preset configurations
    在 themes、plugins和 presets 字段中分别列出您网站的主题、插件和预设
  • Custom configurations
    Docusaurus 保护docusaurus.config.js来自未知领域。要添加自定义字段,请在 customFields 中定义它们。
    站点中所有组件都可以访问配置对象.
import React from 'react';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';

const Hello = () => {
  const {siteConfig} = useDocusaurusContext();
  const {title, tagline} = siteConfig;

  return <div>{`${title} · ${tagline}`}</div>;
};

Docusaurus 默认使用 Babel 转译你网站的源代码。如果你想自定义 Babel 配置,你可以通过在项目根目录中创建一个 babel.config.js 文件来实现

yarn add @docusaurus/babel

babel.config.js
export default {
  presets: ['@docusaurus/babel/preset'],
};
0

评论区