Skip to content

Commit 58d94a2

Browse files
jeevasusejjeevasusej
committed
command
1 parent 3574164 commit 58d94a2

File tree

2 files changed

+66
-2
lines changed

2 files changed

+66
-2
lines changed

‎.github/workflows/storybook.yml‎

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,65 @@ jobs:
3737
- name: Generate TypeDoc documentation
3838
run: npm run docs
3939

40-
# Step 3: Create a simple navigation page (optional)
40+
# Step 3: Create an HTML index file for the Markdown documentation
41+
- name: Create HTML index for Markdown docs
42+
run: |
43+
cat > storybook-static/api/index.html << 'EOL'
44+
<!DOCTYPE html>
45+
<html lang="en">
46+
<head>
47+
<meta charset="UTF-8">
48+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
49+
<title>TanStack Table Adapter API</title>
50+
<style>
51+
body {
52+
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, 'Open Sans', 'Helvetica Neue', sans-serif;
53+
line-height: 1.6;
54+
color: #333;
55+
max-width: 900px;
56+
margin: 0 auto;
57+
padding: 20px;
58+
}
59+
h1 {
60+
border-bottom: 1px solid #eaecef;
61+
padding-bottom: 0.3em;
62+
}
63+
a {
64+
color: #0366d6;
65+
text-decoration: none;
66+
}
67+
a:hover {
68+
text-decoration: underline;
69+
}
70+
.back-link {
71+
margin-bottom: 20px;
72+
display: inline-block;
73+
}
74+
.content {
75+
background-color: #f6f8fa;
76+
border: 1px solid #ddd;
77+
border-radius: 3px;
78+
padding: 20px;
79+
}
80+
</style>
81+
</head>
82+
<body>
83+
<a href="../" class="back-link">← Back to Storybook</a>
84+
<h1>TanStack Table Adapter API Documentation</h1>
85+
<div class="content">
86+
<p>This is the API documentation for the TanStack Table Adapter library.</p>
87+
<p>Please navigate to the <a href="./README.md">README</a> or <a href="./modules.md">Modules</a> to start exploring the API.</p>
88+
<h2>Main Documentation Files</h2>
89+
<ul>
90+
<li><a href="./README.md">README</a> - Overview of the library</li>
91+
<li><a href="./modules.md">Modules</a> - List of all modules</li>
92+
</ul>
93+
</div>
94+
</body>
95+
</html>
96+
EOL
97+
98+
# Step 4: Create a simple navigation page
4199
- name: Create navigation page
42100
run: |
43101
echo '<!DOCTYPE html>
@@ -61,6 +119,12 @@ jobs:
61119
</body>
62120
</html>' > storybook-static/docs-home.html
63121
122+
# Add debugging step to see what files were generated
123+
- name: Check TypeDoc output
124+
run: |
125+
echo "Files in API directory:"
126+
ls -la storybook-static/api/
127+
64128
- name: Setup Pages
65129
uses: actions/configure-pages@v4
66130

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"build-storybook": "storybook build",
1919
"clean": "rimraf dist",
2020
"prepare": "npm run clean && npm run build && npm run build:types",
21-
"docs": "typedoc --tsconfig tsconfig.docs.json --out storybook-static/api src/index.ts",
21+
"docs": "typedoc --tsconfig tsconfig.docs.json",
2222
"build-docs": "npm run build-storybook && npm run docs"
2323
},
2424
"keywords": [

0 commit comments

Comments
 (0)