1
- import { themes as prismThemes } from ' prism-react-renderer' ;
2
- import type { Config } from ' @docusaurus/types' ;
3
- import type * as Preset from ' @docusaurus/preset-classic' ;
1
+ import { themes as prismThemes } from " prism-react-renderer" ;
2
+ import type { Config } from " @docusaurus/types" ;
3
+ import type * as Preset from " @docusaurus/preset-classic" ;
4
4
5
5
const config : Config = {
6
- title : 'ProvenanceWidgets' ,
7
- tagline : 'A JavaScript Library of UI Controls to Track and Dynamically Overlay Analytic Provenance' ,
8
- favicon : 'img/favicon.ico' ,
6
+ title : "ProvenanceWidgets" ,
7
+ tagline :
8
+ "A JavaScript Library of UI Controls to Track and Dynamically Overlay Analytic Provenance" ,
9
+ favicon : "img/favicon.ico" ,
9
10
customFields : {
10
- authors : [ 'Arpit Narechania' , 'Kaustubh Odak' , 'Mennatallah El-Assady' , 'Alex Endert' ] ,
11
- institutes : [ 'Georgia Institute of Technology' , 'ETH Zürich' ] ,
11
+ authors : [
12
+ "Arpit Narechania" ,
13
+ "Kaustubh Odak" ,
14
+ "Mennatallah El-Assady" ,
15
+ "Alex Endert" ,
16
+ ] ,
17
+ institutes : [ "Georgia Institute of Technology" , "ETH Zürich" ] ,
12
18
} ,
13
19
// Set the production url of your site here
14
- url : ' https://provenancewidgets.github.io/' ,
20
+ url : " https://provenancewidgets.github.io/" ,
15
21
// Set the /<baseUrl>/ pathname under which your site is served
16
22
// For GitHub pages deployment, it is often '/<projectName>/'
17
- baseUrl : '/' ,
23
+ baseUrl : "/" ,
18
24
19
25
// GitHub pages deployment config.
20
26
// If you aren't using GitHub pages, you don't need these.
21
- organizationName : ' ProvenanceWidgets' , // Usually your GitHub org/user name.
22
- projectName : ' ProvenanceWidgets' , // Usually your repo name.
27
+ organizationName : " ProvenanceWidgets" , // Usually your GitHub org/user name.
28
+ projectName : " ProvenanceWidgets" , // Usually your repo name.
23
29
24
- onBrokenLinks : ' throw' ,
25
- onBrokenMarkdownLinks : ' warn' ,
30
+ onBrokenLinks : " throw" ,
31
+ onBrokenMarkdownLinks : " warn" ,
26
32
27
33
// Even if you don't use internationalization, you can use this field to set
28
34
// useful metadata like html lang. For example, if your site is Chinese, you
29
35
// may want to replace "en" with "zh-Hans".
30
36
i18n : {
31
- defaultLocale : 'en' ,
32
- locales : [ 'en' ] ,
37
+ defaultLocale : "en" ,
38
+ locales : [ "en" ] ,
33
39
} ,
34
40
35
41
presets : [
36
42
[
37
- ' classic' ,
43
+ " classic" ,
38
44
{
39
45
docs : {
40
- sidebarPath : ' ./sidebars.ts' ,
46
+ sidebarPath : " ./sidebars.ts" ,
41
47
} ,
42
48
blog : {
43
49
showReadingTime : false ,
@@ -46,117 +52,108 @@ const config: Config = {
46
52
xslt : true ,
47
53
} ,
48
54
// Useful options to enforce blogging best practices
49
- onInlineTags : ' warn' ,
50
- onInlineAuthors : ' warn' ,
51
- onUntruncatedBlogPosts : ' warn' ,
52
- routeBasePath : ' /show' ,
55
+ onInlineTags : " warn" ,
56
+ onInlineAuthors : " warn" ,
57
+ onUntruncatedBlogPosts : " warn" ,
58
+ routeBasePath : " /show" ,
53
59
blogSidebarCount : 0 ,
54
- showLastUpdateTime : false
60
+ showLastUpdateTime : false ,
55
61
} ,
56
62
theme : {
57
- customCss : ' ./src/css/custom.css' ,
63
+ customCss : " ./src/css/custom.css" ,
58
64
} ,
59
65
} satisfies Preset . Options ,
60
66
] ,
61
67
] ,
62
68
63
69
themeConfig : {
64
70
// Replace with your project's social card
65
- image : ' img/pw-social-card.png' ,
71
+ image : " img/pw-social-card.png" ,
66
72
navbar : {
67
- title : ' ProvenanceWidgets' ,
73
+ title : " ProvenanceWidgets" ,
68
74
logo : {
69
- alt : ' ProvenanceWidgets Logo' ,
70
- src : ' img/logo-light.svg' ,
71
- srcDark : ' img/logo-dark.svg' ,
75
+ alt : " ProvenanceWidgets Logo" ,
76
+ src : " img/logo-light.svg" ,
77
+ srcDark : " img/logo-dark.svg" ,
72
78
} ,
73
79
items : [
74
80
{
75
- type : ' docSidebar' ,
76
- sidebarId : ' tutorialSidebar' ,
77
- position : ' left' ,
78
- label : ' Docs' ,
81
+ type : " docSidebar" ,
82
+ sidebarId : " tutorialSidebar" ,
83
+ position : " left" ,
84
+ label : " Docs" ,
79
85
} ,
80
86
{
81
- to : ' docs/showcase/' ,
82
- label : ' Showcase' ,
83
- position : ' left'
87
+ to : " docs/showcase/" ,
88
+ label : " Showcase" ,
89
+ position : " left" ,
84
90
} ,
85
91
{
86
92
href : `https://github.com/ProvenanceWidgets/ProvenanceWidgets` ,
87
- label : ' GitHub' ,
88
- position : ' right' ,
93
+ label : " GitHub" ,
94
+ position : " right" ,
89
95
} ,
90
96
] ,
91
97
} ,
92
98
footer : {
93
- style : ' dark' ,
99
+ style : " dark" ,
94
100
links : [
95
101
{
96
- title : ' Links' ,
102
+ title : " Links" ,
97
103
items : [
98
104
{
99
- label : ' GitHub' ,
100
- href : ' https://github.com/ProvenanceWidgets/ProvenanceWidgets' ,
105
+ label : " GitHub" ,
106
+ href : " https://github.com/ProvenanceWidgets/ProvenanceWidgets" ,
101
107
} ,
102
108
{
103
- label : ' arXiv Preprint' ,
104
- href : ' https://arxiv.org/abs/2407.17431' ,
109
+ label : " arXiv Preprint" ,
110
+ href : " https://arxiv.org/abs/2407.17431" ,
105
111
} ,
106
112
{
107
- label : ' Supplemental Material (VIS 2024)' ,
108
- href : ' https://github.com/ProvenanceWidgets/Supplemental-Material'
109
- }
113
+ label : " Supplemental Material (VIS 2024)" ,
114
+ href : " https://github.com/ProvenanceWidgets/Supplemental-Material" ,
115
+ } ,
110
116
] ,
111
117
} ,
112
118
{
113
- title : ' Contacts' ,
119
+ title : " Contacts" ,
114
120
items : [
115
121
{
116
- label : ' Arpit Narechania' ,
117
- href : ' https://arpitnarechania.github.io/'
122
+ label : " Arpit Narechania" ,
123
+ href : " https://arpitnarechania.github.io/" ,
118
124
} ,
119
125
{
120
- label : ' Kaustubh Odak' ,
121
- href : ' https://kaustubhodak.me/'
126
+ label : " Kaustubh Odak" ,
127
+ href : " https://kaustubhodak.me/" ,
122
128
} ,
123
129
{
124
- label : ' Mennatallah El-Assady' ,
125
- href : ' https://el-assady.com/'
130
+ label : " Mennatallah El-Assady" ,
131
+ href : " https://el-assady.com/" ,
126
132
} ,
127
133
{
128
- label : ' Alex Endert' ,
129
- href : ' https://va.gatech.edu/endert/'
130
- }
134
+ label : " Alex Endert" ,
135
+ href : " https://va.gatech.edu/endert/" ,
136
+ } ,
131
137
] ,
132
138
} ,
133
139
] ,
134
- copyright : `Copyright © ${ new Date ( ) . getFullYear ( ) } ProvenanceWidgets`
140
+ copyright : `Copyright © ${ new Date ( ) . getFullYear ( ) } ProvenanceWidgets` ,
135
141
} ,
136
142
prism : {
137
- additionalLanguages : [ ' bash' , ' json' , ' typescript' ] ,
143
+ additionalLanguages : [ " bash" , " json" , " typescript" ] ,
138
144
theme : prismThemes . oneLight ,
139
- darkTheme : prismThemes . oceanicNext
145
+ darkTheme : prismThemes . oceanicNext ,
140
146
} ,
141
147
colorMode : {
142
148
respectPrefersColorScheme : true ,
143
149
} ,
144
- announcementBar : {
145
- content : '⚠️ ProvenanceWidgets is not yet fully compatible with Safari. We recommend using a chromium-based browser or Firefox for the best experience.' ,
146
- backgroundColor : 'var(--ifm-color-danger-darker)' ,
147
- textColor : 'white'
148
- }
149
150
} satisfies Preset . ThemeConfig ,
150
151
151
- clientModules : [
152
- require . resolve ( './src/pw.js' )
153
- ] ,
152
+ clientModules : [ require . resolve ( "./src/pw.js" ) ] ,
154
153
155
- themes : [ ' @docusaurus/theme-live-codeblock' ] ,
154
+ themes : [ " @docusaurus/theme-live-codeblock" ] ,
156
155
157
- stylesheets : [
158
- '/styles/styles.css'
159
- ] ,
156
+ stylesheets : [ "/styles/styles.css" ] ,
160
157
} ;
161
158
162
159
export default config ;
0 commit comments