Apache KIE 网站项目教程
incubator-kie-websiteApache KIE Website项目地址:https://gitcode.com/gh_mirrors/in/incubator-kie-website
1、项目的目录结构及介绍
Apache KIE 网站项目的目录结构如下:
incubator-kie-website/
├── github/workflows/
├── blog/
├── docs/
├── src/
├── static/
├── .asf.yaml
├── .gitignore
├── LICENSE
├── NOTICE
├── README.md
├── babel.config.js
├── docusaurus.config.ts
├── package.json
├── sidebars.ts
├── tsconfig.json
└── yarn.lock
目录介绍
github/workflows/
: 包含 GitHub Actions 的工作流配置文件。blog/
: 存放博客文章的目录。docs/
: 存放文档的目录。src/
: 项目的源代码目录。static/
: 静态资源文件目录。.asf.yaml
: Apache 软件基金会配置文件。.gitignore
: Git 忽略文件配置。LICENSE
: 项目许可证文件。NOTICE
: 项目通知文件。README.md
: 项目说明文档。babel.config.js
: Babel 配置文件。docusaurus.config.ts
: Docusaurus 配置文件。package.json
: 项目依赖和脚本配置文件。sidebars.ts
: 文档侧边栏配置文件。tsconfig.json
: TypeScript 配置文件。yarn.lock
: Yarn 锁定文件。
2、项目的启动文件介绍
项目的启动文件主要是 package.json
中的脚本配置。以下是一些关键的启动命令:
yarn start
: 启动本地开发服务器,并打开浏览器窗口。大多数更改会实时反映,无需重启服务器。yarn build
: 生成静态内容到build
目录,可以使用任何静态内容托管服务进行部署。
3、项目的配置文件介绍
docusaurus.config.ts
这是 Docusaurus 的主要配置文件,包含网站的元数据、插件、主题等配置。以下是一些关键配置项:
const config = {
title: 'Apache KIE',
tagline: 'Knowledge Is Everything',
url: 'https://kie.apache.org',
baseUrl: '/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/favicon.ico',
organizationName: 'apache',
projectName: 'incubator-kie-website',
themes: ['@docusaurus/theme-classic'],
plugins: [],
presets: [
[
'@docusaurus/preset-classic',
{
docs: {
sidebarPath: require.resolve('./sidebars.ts'),
},
blog: {
showReadingTime: true,
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
},
],
],
};
export default config;
babel.config.js
这是 Babel 的配置文件,用于配置 JavaScript 的转译规则。
module.exports = {
presets: [
[
'@docusaurus/core/babel-preset',
{
runtime: 'automatic',
useBuiltIns: 'usage',
corejs: 3,
},
],
],
};
tsconfig.json
这是 TypeScript 的配置文件,用于配置 TypeScript 编译选项。
{
"compilerOptions": {
"target": "es5",
"lib": ["dom", "esnext"],
"allowJs": true,
"skipLibCheck": true,
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
"strict": true,
"forceConsistentCasingInFileNames": true,
"module": "esnext",
"moduleResolution": "node",
"resolveJsonModule": true,
"isolatedModules": true,
"noEmit": true,
"jsx": "preserve"
},
"include": ["src", "docusaurus
incubator-kie-websiteApache KIE Website项目地址:https://gitcode.com/gh_mirrors/in/incubator-kie-website