默认主题

create-react-doc 的默认主题为 crd-seed。该主题有以下特性:

  • 适配移动、PC 多端展示。
  • 支持暗黑模式。
  • 文档支持内嵌 codepen、codesandbox。
  • GitHub 联动。

使用该主题搭建的项目有:

如果您有其它的改进优化想法, 欢迎留言补充

config.yml

config.yml 文件是配置站点主题功能的地方。

它支持配置的属性如下:

属性名作用类型默认
title站点名string
menu作为站点菜单的文件/文件夹路径string[]
menuOpenKeys默认展开菜单的文件夹路径string
userGithub 用户名string
repoGithub 项目名string
language站点语言en | zh-cnen
github-ribbons是否在右上角显示 github 丝带booleanfalse
theme使用主题stringcrd-seed
devTheme开发自定义主题时, 需设置其为 truestring./index
seo是否开启 SEO 优化{ google?: boolean }
domainSEO 优化的站点域名, 用于生成 sitemapstring

详细用法可以参考 config.yml