Skip to content

Commit a9d9268

Browse files
committed
feat: safari compat
1 parent 9eb7f30 commit a9d9268

File tree

4 files changed

+74
-83
lines changed

4 files changed

+74
-83
lines changed

docs/index.mdx

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,6 @@ ProvenanceWidgets is a Javascript library of UI control elements that track and
1616
- [Node.js](https://nodejs.org/en/download/) version 20.0 or above and npm version 10.0 or above:
1717
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
1818

19-
:::warning
20-
21-
ProvenanceWidgets is not fully compatible with Safari. We recommend using a chromium-based browser or Firefox for the best experience.
22-
23-
:::
24-
2519
## Quick Start
2620

2721
For getting started quickly, clone one of our starter code repositories:

docusaurus.config.ts

Lines changed: 69 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,49 @@
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";
44

55
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",
910
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"],
1218
},
1319
// Set the production url of your site here
14-
url: 'https://provenancewidgets.github.io/',
20+
url: "https://provenancewidgets.github.io/",
1521
// Set the /<baseUrl>/ pathname under which your site is served
1622
// For GitHub pages deployment, it is often '/<projectName>/'
17-
baseUrl: '/',
23+
baseUrl: "/",
1824

1925
// GitHub pages deployment config.
2026
// 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.
2329

24-
onBrokenLinks: 'throw',
25-
onBrokenMarkdownLinks: 'warn',
30+
onBrokenLinks: "throw",
31+
onBrokenMarkdownLinks: "warn",
2632

2733
// Even if you don't use internationalization, you can use this field to set
2834
// useful metadata like html lang. For example, if your site is Chinese, you
2935
// may want to replace "en" with "zh-Hans".
3036
i18n: {
31-
defaultLocale: 'en',
32-
locales: ['en'],
37+
defaultLocale: "en",
38+
locales: ["en"],
3339
},
3440

3541
presets: [
3642
[
37-
'classic',
43+
"classic",
3844
{
3945
docs: {
40-
sidebarPath: './sidebars.ts',
46+
sidebarPath: "./sidebars.ts",
4147
},
4248
blog: {
4349
showReadingTime: false,
@@ -46,117 +52,108 @@ const config: Config = {
4652
xslt: true,
4753
},
4854
// 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",
5359
blogSidebarCount: 0,
54-
showLastUpdateTime: false
60+
showLastUpdateTime: false,
5561
},
5662
theme: {
57-
customCss: './src/css/custom.css',
63+
customCss: "./src/css/custom.css",
5864
},
5965
} satisfies Preset.Options,
6066
],
6167
],
6268

6369
themeConfig: {
6470
// Replace with your project's social card
65-
image: 'img/pw-social-card.png',
71+
image: "img/pw-social-card.png",
6672
navbar: {
67-
title: 'ProvenanceWidgets',
73+
title: "ProvenanceWidgets",
6874
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",
7278
},
7379
items: [
7480
{
75-
type: 'docSidebar',
76-
sidebarId: 'tutorialSidebar',
77-
position: 'left',
78-
label: 'Docs',
81+
type: "docSidebar",
82+
sidebarId: "tutorialSidebar",
83+
position: "left",
84+
label: "Docs",
7985
},
8086
{
81-
to: 'docs/showcase/',
82-
label: 'Showcase',
83-
position: 'left'
87+
to: "docs/showcase/",
88+
label: "Showcase",
89+
position: "left",
8490
},
8591
{
8692
href: `https://github.com/ProvenanceWidgets/ProvenanceWidgets`,
87-
label: 'GitHub',
88-
position: 'right',
93+
label: "GitHub",
94+
position: "right",
8995
},
9096
],
9197
},
9298
footer: {
93-
style: 'dark',
99+
style: "dark",
94100
links: [
95101
{
96-
title: 'Links',
102+
title: "Links",
97103
items: [
98104
{
99-
label: 'GitHub',
100-
href: 'https://github.com/ProvenanceWidgets/ProvenanceWidgets',
105+
label: "GitHub",
106+
href: "https://github.com/ProvenanceWidgets/ProvenanceWidgets",
101107
},
102108
{
103-
label: 'arXiv Preprint',
104-
href: 'https://arxiv.org/abs/2407.17431',
109+
label: "arXiv Preprint",
110+
href: "https://arxiv.org/abs/2407.17431",
105111
},
106112
{
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+
},
110116
],
111117
},
112118
{
113-
title: 'Contacts',
119+
title: "Contacts",
114120
items: [
115121
{
116-
label: 'Arpit Narechania',
117-
href: 'https://arpitnarechania.github.io/'
122+
label: "Arpit Narechania",
123+
href: "https://arpitnarechania.github.io/",
118124
},
119125
{
120-
label: 'Kaustubh Odak',
121-
href: 'https://kaustubhodak.me/'
126+
label: "Kaustubh Odak",
127+
href: "https://kaustubhodak.me/",
122128
},
123129
{
124-
label: 'Mennatallah El-Assady',
125-
href: 'https://el-assady.com/'
130+
label: "Mennatallah El-Assady",
131+
href: "https://el-assady.com/",
126132
},
127133
{
128-
label: 'Alex Endert',
129-
href: 'https://va.gatech.edu/endert/'
130-
}
134+
label: "Alex Endert",
135+
href: "https://va.gatech.edu/endert/",
136+
},
131137
],
132138
},
133139
],
134-
copyright: `Copyright © ${new Date().getFullYear()} ProvenanceWidgets`
140+
copyright: `Copyright © ${new Date().getFullYear()} ProvenanceWidgets`,
135141
},
136142
prism: {
137-
additionalLanguages: ['bash', 'json', 'typescript'],
143+
additionalLanguages: ["bash", "json", "typescript"],
138144
theme: prismThemes.oneLight,
139-
darkTheme: prismThemes.oceanicNext
145+
darkTheme: prismThemes.oceanicNext,
140146
},
141147
colorMode: {
142148
respectPrefersColorScheme: true,
143149
},
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-
}
149150
} satisfies Preset.ThemeConfig,
150151

151-
clientModules: [
152-
require.resolve('./src/pw.js')
153-
],
152+
clientModules: [require.resolve("./src/pw.js")],
154153

155-
themes: ['@docusaurus/theme-live-codeblock'],
154+
themes: ["@docusaurus/theme-live-codeblock"],
156155

157-
stylesheets: [
158-
'/styles/styles.css'
159-
],
156+
stylesheets: ["/styles/styles.css"],
160157
};
161158

162159
export default config;

package-lock.json

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"@microlink/react-json-view": "^1.23.1",
2323
"clsx": "^2.0.0",
2424
"prism-react-renderer": "^2.3.0",
25-
"provenance-widgets": "^0.0.1",
25+
"provenance-widgets": "^1.0.2",
2626
"react": "^18.0.0",
2727
"react-dom": "^18.0.0"
2828
},

0 commit comments

Comments
 (0)