-
-
Notifications
You must be signed in to change notification settings - Fork 465
Expand file tree
/
Copy pathdocusaurus.config.ts
More file actions
204 lines (194 loc) · 6.13 KB
/
docusaurus.config.ts
File metadata and controls
204 lines (194 loc) · 6.13 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
import { themes as prismThemes } from 'prism-react-renderer'
import type { Config } from '@docusaurus/types'
import type * as Preset from '@docusaurus/preset-classic'
const typedocWatch = false
const config: Config = {
title: 'React Native document picker & viewer',
tagline: 'Modules for picking and previewing documents in React Native applications',
favicon: 'img/favicon.ico',
// Set the production url of your site here
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: '/',
trailingSlash: false,
url: 'https://react-native-documents.github.io',
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'react-native-documents', // Usually your GitHub org/user name.
projectName: 'react-native-documents.github.io', // Usually your repo name.
deploymentBranch: 'gh-pages',
onBrokenLinks: 'throw',
onBrokenAnchors: 'throw',
onBrokenMarkdownLinks: 'throw',
// Even if you don't use internationalization, you can use this field to set
// useful metadata like html lang. For example, if your site is Chinese, you
// may want to replace "en" with "zh-Hans".
i18n: {
defaultLocale: 'en',
locales: ['en'],
},
presets: [
[
'classic',
{
docs: {
sidebarPath: './sidebars.ts',
editUrl: 'https://github.com/react-native-documents/document-picker/edit/main/docs',
},
blog: false,
// blog: {
// showReadingTime: true,
// // Please change this to your repo.
// // Remove this to remove the "edit this page" links.
// editUrl:
// 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
// },
theme: {
customCss: './src/css/custom.css',
},
} satisfies Preset.Options,
],
],
plugins: [
// [
// 'docusaurus-preset-shiki-twoslash',
// {
// themes: ['min-light', 'nord'],
// },
// ],
...(process.env.ENABLE_DOC_GEN === 'true'
? [
[
'docusaurus-plugin-typedoc',
{
// https://typedoc.org/options/input
id: 'docPickerAPI',
entryPoints: ['../packages/document-picker/src/index.ts'],
tsconfig: '../tsconfig.json',
watch: typedocWatch,
outputFileStrategy: 'modules',
out: 'docs/doc-picker-api',
cleanOutputDir: true,
disableSources: true,
expandObjects: true,
expandParameters: true, // this is nice and doesn't need much space
readme: 'none',
name: 'document-picker API',
parametersFormat: 'table',
typeDeclarationFormat: 'table',
classPropertiesFormat: 'table',
},
],
[
'docusaurus-plugin-typedoc',
{
id: 'docViewerAPI',
// https://typedoc.org/options/input
entryPoints: ['../packages/document-viewer/src/index.ts'],
tsconfig: '../tsconfig.json',
watch: typedocWatch,
outputFileStrategy: 'modules',
out: 'docs/doc-viewer-api',
cleanOutputDir: true,
disableSources: true,
expandObjects: true,
expandParameters: true, // this is nice and doesn't need much space
readme: 'none',
name: 'document-viewer API',
parametersFormat: 'table',
typeDeclarationFormat: 'table',
classPropertiesFormat: 'table',
},
],
]
: []),
[
'docusaurus-lunr-search',
{
disableVersioning: true,
excludeRoutes: ['/docs/license', '/docs/sponsor-only/license'],
},
],
[
'@docusaurus/plugin-ideal-image',
{
quality: 80,
disableInDev: false,
},
],
],
themeConfig: {
announcementBar: {
id: 'announcementBar',
content:
'Find these packages useful? Say thanks by <a target="_blank" href="https://github.com/sponsors/vonovak">sponsoring</a> the author on GitHub!',
// isCloseable: true,
},
// Replace with your project's social card
colorMode: {
respectPrefersColorScheme: true,
},
image: 'img/docusaurus-social-card.jpg',
navbar: {
title: 'RN Document picker & viewer',
logo: {
alt: 'My Site Logo',
src: 'img/logo.png',
},
items: [
{
type: 'docSidebar',
sidebarId: 'guidesSidebar',
position: 'left',
label: 'Guides',
},
{ to: 'docs/doc-picker-api', label: 'Picker API', position: 'left' },
{ to: 'docs/doc-viewer-api', label: 'Viewer API', position: 'left' },
{
to: 'https://github.com/react-native-documents/document-picker/tree/main/packages/example',
label: 'Example app',
position: 'right',
},
{
href: 'https://github.com/react-native-documents/document-picker',
label: 'GitHub',
position: 'right',
},
],
},
footer: {
style: 'dark',
links: [
// {
// title: 'Docs',
// items: [
// {
// label: 'Intro',
// to: '/docs/intro',
// },
// ],
// },
// {
// title: 'More',
// items: [
// {
// label: 'Blog',
// to: '/blog',
// },
// {
// label: 'GitHub',
// href: 'https://github.com',
// },
// ],
// },
],
copyright: `Copyright © ${new Date().getFullYear()} <a href="https://github.com/vonovak" target=”_blank”>Vojtech Novak</a>. Built with Docusaurus.`,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
} satisfies Preset.ThemeConfig,
}
console.log({ config: JSON.stringify(config.plugins) })
export default config