@rick-zhang/docusaurus-preset-tech

一个增强的 Docusaurus 预设包，包含丰富的自定义组件、样式和插件，专为技术文档网站设计。

功能特性

• 快速开发*: 基于 Docusaurus 3.9.2
• 完整的样式系统*: 包含完整的 CSS 样式，开箱即用
• 丰富的自定义组件库*: 包含多种实用的 React 组件
• 增强插件集合*: 内置多种实用插件
• 优化的主题配置*: 预设了最佳的主题配置
• 响应式设计*: 支持移动端和桌面端
• 主题切换*: 支持明暗主题切换
• 数学公式支持*: 内置 KaTeX 支持，支持 LaTeX 数学公式
• 思维导图*: 支持 Markmap 思维导图
• 图片增强*: 支持图片缩放和画廊功能
• TypeScript 支持*: 完整的类型定义和类型安全

安装

npm install @rick-zhang/docusaurus-preset-tech
# 或
yarn add @rick-zhang/docusaurus-preset-tech

快速开始

方式一：使用 createPresetConfig（推荐）

import {createPresetConfig} from '@rick-zhang/docusaurus-preset-tech/lib/index';
import type {Config} from '@docusaurus/types';

const config: Config = createPresetConfig({
  title: '我的技术文档',
  tagline: '使用 @rick-zhang/docusaurus-preset-tech 构建的技术文档网站',
  organizationName: 'your-org',
  projectName: 'your-project',
  baseUrl: '/',
  url: 'https://your-domain.com',
});

export default config;

方式二：使用标准 preset

import type {Config} from '@docusaurus/types';
import preset from '@rick-zhang/docusaurus-preset-tech';

const config: Config = {
  title: '我的技术文档',
  tagline: '使用 @rick-zhang/docusaurus-preset-tech 构建',
  organizationName: 'your-org',
  projectName: 'your-project',
  baseUrl: '/',
  url: 'https://your-domain.com',
  
  presets: [
    [
      '@rick-zhang/docusaurus-preset-tech',
      {
        debug: false,
        docs: {
          path: 'docs',
          sidebarPath: 'sidebars.ts',
        },
        blog: {
          path: 'blog',
        },
      },
    ],
  ],
};

export default config;

使用组件

import {
  Markmap,
  APITable,
  BrowserWindow,
  ColorGenerator,
  Tweet,
  TweetQuote,
} from '@rick-zhang/docusaurus-preset-tech/components';

文档

更多详细文档请参考：文档网站

许可证

MIT

作者

Rick Zhang