-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathdocusaurus.config.js
More file actions
271 lines (261 loc) · 8.57 KB
/
Copy pathdocusaurus.config.js
File metadata and controls
271 lines (261 loc) · 8.57 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
/* eslint-disable prettier/prettier */
/* eslint-disable @typescript-eslint/no-var-requires */
const path = require('path');
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
const lightCodeTheme = require('prism-react-renderer/themes/github');
const { specs } = require('./redoc.config');
const DOCS_URL = process.env.DOCS_URL || 'https://docs.epilot.io';
// Internal flag: the Agent Toolkit is hidden from the public site until launch.
// Build with SHOW_AGENT_TOOLKIT=true to include the page, nav links, and promos.
const showAgentToolkit = process.env.SHOW_AGENT_TOOLKIT === 'true';
// With JSDoc @type annotations, IDEs can provide config autocompletion
/** @type {import('@docusaurus/types').DocusaurusConfig} */
(module.exports = {
title: 'epilot dev center',
tagline: 'The Energy XRM - for developers.',
url: DOCS_URL,
baseUrl: '/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/favicon.svg',
organizationName: 'epilot-dev',
projectName: 'docs',
customFields: {
showAgentToolkit,
},
presets: [
[
'@docusaurus/preset-classic',
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
id: 'default',
sidebarPath: require.resolve('./sidebars.js'),
editUrl: 'https://github.com/epilot-dev/docs/edit/main/',
remarkPlugins: [require('mdx-mermaid')],
},
pages: {
exclude: [
// plugin-content-pages defaults (replaced when `exclude` is set)
'**/_*.{js,jsx,ts,tsx,md,mdx}',
'**/_*/**',
'**/*.test.{js,jsx,ts,tsx}',
'**/__tests__/**',
...(showAgentToolkit ? [] : ['agent-toolkit/**']),
],
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
}),
],
[
'redocusaurus',
{
debug: Boolean(process.env.DEBUG || process.env.CI),
specs: specs.map((spec) => ({ ...spec, apiDocComponent: '../src/components/RedocPage' })),
theme: {
primaryColor: '#4C4CFF',
redocOptions: {
hideDownloadButton: false,
nativeScrollbars: true,
pathInMiddlePanel: true,
},
},
},
],
],
clientModules: [require.resolve('./src/clientModules/playgroundNewTab.js')],
plugins: [
function mermaidAliasPlugin() {
return {
name: 'mermaid-alias',
configureWebpack() {
return {
resolve: {
alias: {
'mdx-mermaid/lib/Mermaid': path.resolve(__dirname, 'src/components/Mermaid.js'),
},
},
};
},
};
},
require.resolve('@cmfcmf/docusaurus-search-local'),
[
'@docusaurus/plugin-client-redirects',
{
redirects: [
{
from: '/docs/entities/schemas-list',
to: '/docs/entities/core-entities',
},
{
// Component options were replaced by app-level options
from: [
'/docs/apps/components/configure-options',
'/apps/components/configure-options',
],
to: '/docs/apps/app-options',
},
],
createRedirects(existingPath) {
// Redirect old /apps/* paths to /docs/apps/*
if (existingPath.includes('/docs/apps')) {
return [existingPath.replace('/docs/apps', '/apps')];
}
// Redirect old ERP Toolkit paths to the rebranded Integration Toolkit
if (existingPath.includes('/docs/integrations/integration-toolkit')) {
return [
existingPath.replace(
'/docs/integrations/integration-toolkit',
'/docs/integrations/erp-toolkit'
),
];
}
return undefined;
},
},
],
[
require.resolve('./src/plugins/llms-txt/index.js'),
{
siteDescription: `epilot is a cloud-native SaaS platform (Energy XRM) designed for energy suppliers and service providers in the German energy market.
The platform provides:
- **Entity Management**: Flexible data modeling with schemas for contacts, products, orders, opportunities, and custom entities
- **Journey Builder**: Visual designer for customer onboarding journeys, self-service portals, and multi-step forms
- **Workflow Engine**: Configurable workflows for business process automation with task management and SLA tracking
- **Automation Engine**: Rule-based automation for entity mapping, document generation, and integrations
- **Portal Framework**: Customer (ECP) and installer portals with granular permissions and self-service capabilities
- **Messaging Hub**: Centralized email and messaging with templates and shared inboxes
- **Integration Toolkit**: Pre-built connectors for SAP, Wilken, and other ERP/billing systems
- **REST APIs & SDK**: Comprehensive APIs for all platform capabilities with TypeScript SDK
- **Document Generation**: Template-based document creation with variable support
- **Pricing & Product Catalog**: Flexible product management with tiered pricing and availability rules
- **AI Features**: AI-powered copilot for entity management, messaging, and workflow automation
- **Apps & Marketplace**: Extensibility platform for third-party and custom applications
This documentation covers all aspects of the epilot platform for developers, administrators, and integration partners.`,
},
],
[
require.resolve('./src/plugins/changelog/index.js'),
{
id: 'api-changelog',
blogTitle: 'API Changelog',
blogDescription: 'Breaking changes, new features, and significant updates to epilot APIs.',
blogSidebarCount: 'ALL',
blogSidebarTitle: 'Changelog',
routeBasePath: '/api/changelog',
changelogFilename: path.join(__dirname, 'CHANGELOG.md'),
showReadingTime: false,
postsPerPage: 25,
archiveBasePath: null,
feedOptions: {
type: 'all',
title: 'epilot API Changelog',
description: 'Breaking changes, new features, and significant updates to epilot APIs.',
language: 'en',
},
},
],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
colorMode: {
respectPrefersColorScheme: true
},
navbar: {
title: 'Dev Center',
logo: {
alt: 'epilot',
src: 'img/logo.png',
},
items: [
{
label: 'Documentation',
type: 'doc',
docId: 'intro',
position: 'left',
},
{
to: '/api',
label: 'REST API',
position: 'left',
},
{
to: '/docs/sdk/overview',
label: 'SDK',
position: 'left',
},
...(showAgentToolkit
? [
{
to: '/agent-toolkit',
label: 'Agent Toolkit',
position: 'left',
},
]
: []),
{
href: 'https://marketplace.epilot.cloud/en',
label: 'Marketplace',
position: 'right',
className: 'navbar-button navbar-button--secondary',
},
{
href: 'https://portal.epilot.cloud',
label: 'Log in',
position: 'right',
className: 'navbar-button navbar-button--primary',
},
],
},
footer: {
style: 'light',
links: [
{
label: 'Documentation',
to: '/docs/intro',
},
{
label: 'REST API',
to: '/api',
},
{
label: 'SDK',
to: '/docs/sdk/overview',
},
...(showAgentToolkit
? [
{
label: 'Agent Toolkit',
to: '/agent-toolkit',
},
]
: []),
{
label: 'GitHub',
href: 'https://github.com/epilot-dev',
},
{
label: 'Blog',
href: 'https://dev.to/epilot',
},
{
label: 'Changelog',
to: '/api/changelog',
},
{
label: 'Careers',
href: 'https://www.epilot.cloud/en/company/careers',
},
],
copyright: `© epilot.cloud ${new Date().getFullYear()}`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
}),
});