@elastic/eui-docusaurus-theme
EUI 自定义 多龙 为欧盟倡议制定的主题 文档网站。 。 。 .
使用量
EUI主题使用 扫地取地 将主题组件切换为 包含 EUI 组件和符号的自定义执行.
先决条件
在开始安装预设之前, 更新您的 Docusaurus 设置以兼容
与 @elastic/eui-docusaurus-theme数字 :
-
安装所需的软件包
yarn add @emotion/react @emotion/css @elastic/charts -
配置类型脚本
您需要添加
jsxImportSource财务报告和审定财务报表moduleResolution到您的项目tsconfig.json数字 :{ // This file is not used in compilation. It is here just for a nice editor experience. "extends": "@docusaurus/tsconfig", "compilerOptions": { "baseUrl": ".", + "jsxImportSource": "@emotion/react", + "moduleResolution": "nodenext" } } -
配置贝贝
添加
@babel/preset-react让情感处理importSource。 。 。 .module.exports = { presets: [ require.resolve('@docusaurus/core/lib/babel/preset'), + [ + '@babel/preset-react', + { runtime: 'automatic', importSource: '@emotion/react' }, + ], ], };
安装预设( 建议)
# npm
npm install @elastic/eui-docusaurus-preset @elastic/eui-docusaurus-theme
# pnpm
pnpm add @elastic/eui-docusaurus-preset @elastic/eui-docusaurus-theme
# Yarn
yarn add @elastic/eui-docusaurus-preset @elastic/eui-docusaurus-theme
和在你的 docusaurus.config.ts 文件,添加:
const config: Config = {
// ...
presets: [
require.resolve('@elastic/eui-docusaurus-preset'),
// ...
],
// ...
}
仅主题
Docusaurus 使用它的默认 CSS 框架 Infima 来样式化经典主题(@docusaurus/theme-classic) (中文(简体) ). EUI Docuraurus主题基于经典主题,但Infima的全局风格往往会压倒或与EUI的设计系统相冲突,导致外观不一致. 这个 ignore-styles-plugin 禁用Infima的样式,确保EUI主题显示正确. 为此,我们强烈建议使用预设而不是独立的主题.
如果您喜欢只使用主题, 请安装软件包 :
# npm
npm install @elastic/eui-docusaurus-theme
# pnpm
pnpm add @elastic/eui-docusaurus-theme
# Yarn
yarn add @elastic/eui-docusaurus-theme
和在你的 docusaurus.config.ts 文件,添加:
const config: Config = {
// ...
themes: [
require.resolve('@docusaurus/theme-classic'), // Required for compatibility
require.resolve('@elastic/eui-docusaurus-theme'),
],
// ...
}
特征
右侧导航链接
实现与该平台类似的右侧导航链接 EUI 文件,必须使用 component 属性,其值为 "changelog" | "github" | "figma"。 。 。 .
themeConfig: {
// ...
navbar: {
// ...
items: [
// ...
// Use component: "changelog" | "github" | "figma"
{
href: "https://github.com/elastic/eui/tree/main/packages/eui/changelogs",
label: "EUI Changelog",
position: "right",
component: "changelog",
},
{
href: "https://github.com/elastic/eui",
label: "GitHub",
position: "right",
component: "github",
},
{
href: "https://www.figma.com/community/file/964536385682658129",
label: "Figma",
position: "right",
component: "figma",
},
],
},
// ...
}
地方发展
先决条件
此软件包需要:
- 节点.js( 请检查当前版本 : .nvmrc (英语), (中文(简体) ),
- 核心软件包。 。 。 .
安装依赖关系
通过运行安装依赖性 :
yarn
构建软件包
yarn build
以监视模式构建
编辑文件时运行以下命令来构建此软件包:
yarn start
* 警告
请注意,这个软件包的配置是为了进行增量构建,有时是 tsc 可能不会更新 lib 如果重命名或删除文件,则带有最新修改的目录.
如果是这样,请跑 yarn build。 。 。 .
* :
EUI 文档网站测试
从单存储器根部运行以下命令以运行网站 :
yarn workspace @elastic/eui-website start
您可以在修改 Docusaurus 主题时将其与表模式相配 .
本地测试您自己的 Docusaurus 项目
你应该有一个 Docuraurus 项目运行。 如果您想用新项目测试 EUI 主题, 您应该创建 Docusaurus 脚手架项目网站。 。 。 .
运行以下命令以创建 Docusaurus 项目 :
npx create-docusaurus@latest my-website classic --typescript
在 root 中,运行下列命令来构建和包装本地预设和主题:
# Build packages
yarn workspace @elastic/eui-docusaurus-theme build
yarn workspace @elastic/eui-docusaurus-preset build
# Pack packages
cd packages/docusaurus-theme
yarn pack --filename docusaurus-theme.tgz
cd ../docusaurus-preset
yarn pack --filename docusaurus-preset.tgz
在您的工程中, 安装 EUI 依赖 :
# npm
npm install @elastic/eui @elastic/charts @emotion/react @emotion/css moment
# pnpm
pnpm add @elastic/eui @elastic/charts @emotion/react @emotion/css moment
# Yarn
yarn add @elastic/eui @elastic/charts @emotion/react @emotion/css moment
并添加本地包装包 :
# npm
npm install /path/to/eui/packages/docusaurus-preset/docusaurus-preset.tgz /path/to/eui/packages/docusaurus-theme/docusaurus-theme.tgz
# pnpm
pnpm add /path/to/eui/packages/docusaurus-preset/docusaurus-preset.tgz /path/to/eui/packages/docusaurus-theme/docusaurus-theme.tgz
# Yarn
yarn add /path/to/eui/packages/docusaurus-preset/docusaurus-preset.tgz /path/to/eui/packages/docusaurus-theme/docusaurus-theme.tgz
配置 Docuraurus 以使用 使用部分。 。 。 .
作出改变
当修改预设或主题时,重建并重新包装套件.
然后在您的项目中重新安装软件包以更新更改 .
重新启动您的 Docusaurus 开发服务器 :
# npm
npm run start
# pnpm
pnpm start
# Yarn
yarn start