Skip to content

Commit 6ac9e4a

Browse files
committed
arxiv preprint, authors, citation, starter repositories, browser warning
1 parent d7e8d3e commit 6ac9e4a

File tree

4 files changed

+66
-4
lines changed

4 files changed

+66
-4
lines changed

docs/intro.mdx

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,25 @@ 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 recommended using a chromium-based browser or Firefox for the best experience.
22+
23+
:::
24+
1925
## Quick Start
2026

21-
For getting started quickly, clone one our starter code repositories:
27+
For getting started quickly, clone one of our starter code repositories:
2228

2329
<Tabs groupId='framework'>
2430
<TabItem value='angular' label='Angular'>
2531
```bash
26-
git clone https://github.com/kausko/provenance-widgets-starter
32+
git clone https://github.com/ProvenanceWidgets/provenance-widgets-starter
2733
```
2834
</TabItem>
2935
<TabItem value='web-components' label='Web Components'>
3036
```bash
31-
git clone https://github.com/kausko/provenance-widgets-vanilla-starter
37+
git clone https://github.com/ProvenanceWidgets/provenance-widgets-vanilla-starter
3238
```
3339
</TabItem>
3440
</Tabs>

docusaurus.config.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ const config: Config = {
9696
href: 'https://github.com/ProvenanceWidgets/ProvenanceWidgets',
9797
},
9898
{
99-
label: 'arXiv',
99+
label: 'arXiv Preprint',
100100
href: 'https://arxiv.org/abs/2407.17431',
101101
},
102102
{
@@ -115,6 +115,14 @@ const config: Config = {
115115
{
116116
label: 'Kaustubh Odak kaustubhodak1 [at] gmail.com',
117117
href: 'mailto:'
118+
},
119+
{
120+
label: 'Mennatallah El-Assady menna.elassady [at] ai.ethz.ch',
121+
href: 'mailto:'
122+
},
123+
{
124+
label: 'Alex Endert endert [at] gatech.edu',
125+
href: 'mailto:'
118126
}
119127
],
120128
},

src/css/custom.css

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,8 @@ web-provenance-slider.ngx-slider {
5151

5252
header time {
5353
display: none;
54+
}
55+
56+
.button--outline:hover {
57+
color: var(--ifm-color-gray-900) !important;
5458
}

src/pages/index.tsx

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
44
import Layout from '@theme/Layout';
55
import Heading from '@theme/Heading';
66
import styles from './index.module.css';
7+
import React from 'react';
78

89
declare global {
910
namespace JSX {
@@ -20,6 +21,24 @@ declare global {
2021

2122
function HomepageHeader() {
2223
const { siteConfig } = useDocusaurusContext();
24+
const [isCopied, setIsCopied] = React.useState(false);
25+
26+
const copyToClipboard = () => {
27+
const citation = `@article{narechania2024provenancewidgets,
28+
title = {{ProvenanceWidgets}: {A Library of UI Control Elements to Track and Dynamically Overlay Analytic Provenance}},
29+
shorttitle = {{ProvenanceWidgets}},
30+
author = {{Narechania}, Arpit and {Odak}, Kaustubh and {El-Assady}, Mennatallah and {Endert}, Alex},
31+
journal = {IEEE Transactions on Visualization and Computer Graphics (TVCG)},
32+
doi = {10.48550/arXiv.2407.17431},
33+
url = {https://doi.org/10.48550/arXiv.2407.17431},
34+
year = {2024},
35+
publisher = {IEEE}
36+
}`
37+
navigator.clipboard.writeText(citation);
38+
setIsCopied(true);
39+
setTimeout(() => setIsCopied(false), 2000);
40+
}
41+
2342
return (
2443
<header className={clsx('hero hero--primary', styles.heroBanner)}>
2544
<div className="container">
@@ -45,6 +64,31 @@ function HomepageHeader() {
4564
to="https://arxiv.org/pdf/2407.17431">
4665
Read the Paper (VIS 2024)
4766
</Link>
67+
<Link
68+
className="button button--outline button--secondary button--lg"
69+
style={{ color: 'var(--ifm-background-surface-color)', display: 'flex', alignItems: 'center', gap: '0.5rem' }}
70+
onClick={copyToClipboard}
71+
>
72+
Cite the Paper
73+
{
74+
isCopied ?
75+
<svg
76+
viewBox="0 0 24 24"
77+
className="copyButtonSuccessIcon_node_modules-@docusaurus-theme-classic-lib-theme-CodeBlock-CopyButton-styles-module"
78+
style={{ position: 'relative', width: '1.125rem', height: '1.125rem', transform: 'none', left: 0, top: 0, opacity: 1 }}
79+
>
80+
<path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path>
81+
</svg>
82+
:
83+
<svg
84+
viewBox="0 0 24 24"
85+
className="copyButtonIcon_node_modules-@docusaurus-theme-classic-lib-theme-CodeBlock-CopyButton-styles-module"
86+
style={{ position: 'relative', width: '1.125rem', height: '1.125rem' }}
87+
>
88+
<path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path>
89+
</svg>
90+
}
91+
</Link>
4892
</div>
4993
</div>
5094
</header>

0 commit comments

Comments
 (0)