快速上手

以极简的方式,让你零配置上手 Nextra 文档主题,以避免复杂的配置

克隆项目

git clone https://github.com/agoodbook/nextra-docs.git

安装依赖

请确保您的NodeJS环境版本在v16.20.2及以上。

npm install
yarn add

介绍项目目录

    • public
      • components
      • pages
      • config.js
      • globalStyle.scss
    • next.config.js
    • theme.config.js
  • public

    存放静态文件,如图片、音频等

    src

    components

    存放公共组件,如有我自定义的Image组件和Table组件

    pages

    存放文档页面

    setting.js

    公共配置,请配置您的Github用户名和仓库地址

    setting.js
    const username = 'BeHer0';
    const repository = 'SimpleDocs';
     
    module.exports = {
      username,
      repository,
    };

    globalStyle.scss

    全局的css样式文件

    1. .light白天主题样式
    2. .dark黑夜主题模式