Skip to content

Commit 036f31b

Browse files
nbierdemannbierdeman
authored
docs: add support for typedoc (#698)
1 parent 491988d commit 036f31b

File tree

9 files changed

+415
-0
lines changed

9 files changed

+415
-0
lines changed

‎.changeset/fair-yaks-impress.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@paypal/paypal-js": patch
3+
---
4+
5+
feat: use typedoc for generating v6 public interface documentation

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
coverage
22
dist
3+
docs/*/
34

45
node_modules
56
.DS_Store

‎docs/README-web-sdk-v6-reference.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# PayPal JS SDK v6 API Reference
2+
3+
Welcome to the PayPal JS SDK v6 API reference documentation. This documentation provides comprehensive TypeScript type definitions and detailed API information for version 6 of PayPal's JavaScript SDK.

‎docs/index.html‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6+
<title>PayPal JS SDK Documentation</title>
7+
<link rel="stylesheet" href="paypal-fonts.css" />
8+
<style>
9+
body {
10+
line-height: 1.6;
11+
color: #333;
12+
max-width: 800px;
13+
margin: 0 auto;
14+
padding: 40px 20px;
15+
background-color: #f8f9fa;
16+
}
17+
.container {
18+
background: white;
19+
padding: 40px;
20+
border-radius: 8px;
21+
box-shadow: 0 2px 10px rgba(0, 0, 0, 0.1);
22+
}
23+
h1 {
24+
color: #000000;
25+
margin-bottom: 10px;
26+
font-size: 2.5em;
27+
font-weight: 300;
28+
}
29+
.subtitle {
30+
color: #666;
31+
margin-bottom: 40px;
32+
font-size: 1.2em;
33+
}
34+
.docs-grid {
35+
display: grid;
36+
gap: 20px;
37+
margin-top: 30px;
38+
}
39+
.doc-card {
40+
border: 1px solid #e1e5e9;
41+
border-radius: 6px;
42+
padding: 24px;
43+
text-decoration: none;
44+
color: inherit;
45+
transition: all 0.2s ease;
46+
background: #fff;
47+
}
48+
.doc-card:hover {
49+
border-color: #000000;
50+
box-shadow: 0 4px 12px rgba(0, 0, 0, 0.15);
51+
transform: translateY(-2px);
52+
}
53+
.doc-card h3 {
54+
margin: 0 0 10px 0;
55+
color: #000000;
56+
font-size: 1.3em;
57+
}
58+
.doc-card p {
59+
margin: 0;
60+
color: #666;
61+
line-height: 1.5;
62+
}
63+
.footer {
64+
text-align: center;
65+
margin-top: 50px;
66+
padding-top: 30px;
67+
border-top: 1px solid #e1e5e9;
68+
color: #666;
69+
font-size: 0.9em;
70+
}
71+
.paypal-logo {
72+
display: inline-block;
73+
font-weight: bold;
74+
color: #000000;
75+
}
76+
</style>
77+
</head>
78+
<body>
79+
<div class="container">
80+
<h1><span class="paypal-logo">PayPal</span> JS SDK</h1>
81+
<p class="subtitle">Documentation Hub</p>
82+
83+
<p>
84+
Welcome to the PayPal JS SDK documentation. Choose from the
85+
available documentation versions below:
86+
</p>
87+
88+
<div class="docs-grid">
89+
<a href="./web-sdk-v6-reference/" class="doc-card">
90+
<h3>JS SDK v6 Reference</h3>
91+
<p>
92+
Complete API reference documentation for PayPal JS SDK
93+
v6, including components, methods, and configuration
94+
options.
95+
</p>
96+
</a>
97+
</div>
98+
99+
<div class="footer">
100+
<p>Documentation for the PayPal JS SDK</p>
101+
</div>
102+
</div>
103+
</body>
104+
</html>

‎docs/paypal-fonts.css‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
@font-face {
2+
font-family: "PayPal Plain";
3+
font-weight: 400;
4+
font-display: swap;
5+
font-style: normal;
6+
src: url("https://www.paypalobjects.com/marketing/pp-com-components/fonts/PayPal%20Plain/PayPalPlain-Regular.woff2")
7+
format("woff2");
8+
}
9+
10+
@font-face {
11+
font-family: "PayPal Plain";
12+
font-weight: 500;
13+
font-display: swap;
14+
font-style: normal;
15+
src: url("https://www.paypalobjects.com/marketing/pp-com-components/fonts/PayPal%20Plain/PayPalPlain-Medium.woff2")
16+
format("woff2");
17+
}
18+
19+
@font-face {
20+
font-family: "PayPal Pro";
21+
font-weight: 400;
22+
font-display: swap;
23+
font-style: normal;
24+
src: url("https://www.paypalobjects.com/marketing/pp-com-components/fonts/PayPal%20Pro/PayPalProSWeb-Book.woff2")
25+
format("woff2");
26+
}
27+
28+
@font-face {
29+
font-family: "PayPal Pro";
30+
font-weight: 900;
31+
font-display: swap;
32+
font-style: normal;
33+
src: url("https://www.paypalobjects.com/marketing/pp-com-components/fonts/PayPal%20Pro/PayPalProSWeb-Black.woff2")
34+
format("woff2");
35+
}
36+
37+
body,
38+
.tsd-page-title,
39+
.tsd-breadcrumb,
40+
.tsd-navigation,
41+
h1,
42+
h2,
43+
h3,
44+
h4,
45+
h5,
46+
h6 {
47+
font-family:
48+
"PayPal Pro",
49+
"PayPal Plain",
50+
-apple-system,
51+
BlinkMacSystemFont,
52+
"Segoe UI",
53+
Roboto,
54+
"Helvetica Neue",
55+
Arial,
56+
sans-serif !important;
57+
}
58+
59+
code,
60+
pre,
61+
.tsd-signature,
62+
.tsd-code-block {
63+
font-family: "SF Mono", Monaco, Menlo, Consolas, "Liberation Mono",
64+
"Courier New", monospace !important;
65+
}

0 commit comments

Comments
 (0)