Skip to content

Commit 75a8b51

Browse files
committed
Update website design
1 parent edb75f4 commit 75a8b51

22 files changed

+2417
-1771
lines changed

assets/logo.svg

Lines changed: 3 additions & 1 deletion
Loading

readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="center">
2-
<img src="https://raw.githubusercontent.com/iddan/react-spreadsheet/master/assets/logo.svg?sanitize=true" height="120">
2+
<img src="https://raw.githubusercontent.com/iddan/react-spreadsheet/master/assets/logo.svg?sanitize=true" height="120" />
33
</div>
44

55
# React Spreadsheet

rollup.config.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import typescript from "rollup-plugin-typescript2";
44
import postcss from "rollup-plugin-postcss";
55
import dts from "rollup-plugin-dts";
6-
import pkg from "./package.json" assert { type: "json" };
6+
import pkg from "./package.json" with { type: "json" };
77

88
function createExternal(dependencies) {
99
return Object.keys(dependencies).flatMap(

typedoc.json

Lines changed: 0 additions & 7 deletions
This file was deleted.

website/.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,7 @@ yarn-error.log*
2424
# ESLint
2525
.eslintcache
2626

27-
static/storybook
27+
static/storybook
28+
!reference
29+
reference/**/*.cjs
30+
reference/**/*.md

website/docs/sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
12
module.exports = {
23
sidebar: [
34
{

website/docusaurus.config.js

Lines changed: 0 additions & 74 deletions
This file was deleted.

website/docusaurus.config.ts

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
import type { DocusaurusConfig } from "@docusaurus/types";
2+
import type * as pluginContentDocs from "@docusaurus/plugin-content-docs";
3+
import type * as docusaurusPluginTypedoc from "docusaurus-plugin-typedoc";
4+
5+
export default {
6+
title: "React Spreadsheet",
7+
tagline: "Simple, customizable yet performant spreadsheet for React",
8+
url: "https://iddan.github.io",
9+
baseUrl: "/react-spreadsheet/",
10+
onBrokenLinks: "throw",
11+
onBrokenMarkdownLinks: "warn",
12+
favicon: "img/favicon.ico",
13+
organizationName: "iddan", // Usually your GitHub org/user name.
14+
projectName: "react-spreadsheet", // Usually your repo name.
15+
themeConfig: {
16+
prism: {
17+
theme: require("prism-react-renderer").themes.nightOwlLight,
18+
darkTheme: require("prism-react-renderer").themes.nightOwl,
19+
},
20+
colorMode: {
21+
defaultMode: "dark",
22+
disableSwitch: false,
23+
respectPrefersColorScheme: true,
24+
},
25+
navbar: {
26+
title: "React Spreadsheet",
27+
logo: {
28+
alt: "React Spreadsheet Logo",
29+
src: "img/logo.svg",
30+
},
31+
items: [
32+
{
33+
type: "search",
34+
position: "right",
35+
},
36+
{
37+
to: "learn/",
38+
activeBasePath: "learn",
39+
label: "Learn",
40+
position: "right",
41+
},
42+
{
43+
to: "reference/variables/Spreadsheet",
44+
label: "Reference",
45+
position: "right",
46+
activeBasePath: "reference",
47+
},
48+
{
49+
href: "https://github.com/iddan/react-spreadsheet",
50+
position: "right",
51+
className: "header-github-link",
52+
"aria-label": "GitHub repository",
53+
},
54+
],
55+
},
56+
},
57+
presets: [
58+
[
59+
"@docusaurus/preset-classic",
60+
{
61+
docs: {
62+
routeBasePath: "learn",
63+
sidebarPath: require.resolve("./docs/sidebars.js"),
64+
// Please change this to your repo.
65+
editUrl:
66+
"https://github.com/iddan/react-spreadsheet/tree/master/website",
67+
},
68+
theme: {
69+
customCss: require.resolve("./src/css/custom.css"),
70+
},
71+
},
72+
],
73+
],
74+
plugins: [
75+
[
76+
"docusaurus-plugin-typedoc",
77+
{
78+
// @ts-expect-error docusaurus-plugin-typedoc is not typed properly
79+
entryPoints: ["../src/index.ts"],
80+
tsconfig: "../tsconfig.json",
81+
out: "reference",
82+
sidebar: {
83+
pretty: true,
84+
autoConfiguration: true,
85+
typescript: false,
86+
deprecatedItemClassName: "deprecated",
87+
}
88+
} satisfies Partial<docusaurusPluginTypedoc.PluginOptions>,
89+
],
90+
[
91+
"@docusaurus/plugin-content-docs",
92+
{
93+
id: "reference",
94+
path: "reference",
95+
routeBasePath: "reference",
96+
sidebarPath: require.resolve("./src/reference-sidebar.js"),
97+
exclude: ["index.md"],
98+
} satisfies Partial<pluginContentDocs.PluginOptions>,
99+
],
100+
],
101+
} satisfies Partial<DocusaurusConfig>;

website/package.json

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,24 +20,25 @@
2020
},
2121
"dependencies": {
2222
"@algolia/client-search": "^4.9.1",
23-
"@docusaurus/core": "^3.6.3",
24-
"@docusaurus/mdx-loader": "^3.6.3",
25-
"@docusaurus/preset-classic": "^3.6.3",
23+
"@docusaurus/core": "^3.9.2",
24+
"@docusaurus/mdx-loader": "^3.9.2",
25+
"@docusaurus/preset-classic": "^3.9.2",
2626
"@mdx-js/react": "^3.0.0",
2727
"@rehooks/component-size": "^1.0.3",
2828
"@svgr/webpack": "^5.5.0",
2929
"@types/react": "^18.0.0",
3030
"clsx": "^1.1.1",
31-
"docusaurus-plugin-typedoc-api": "^4.4.0",
31+
"docusaurus-plugin-typedoc": "^1.4.2",
3232
"file-loader": "^6.2.0",
33+
"prism-react-renderer": "^2.4.1",
3334
"react": "^18.0.0",
3435
"react-dom": "^18.0.0",
3536
"react-loadable": "^5.5.0",
36-
"react-spreadsheet": "^0.8.0",
37+
"react-spreadsheet": "^0.10.1",
3738
"scheduler": "^0.23.0",
3839
"search-insights": "^2.17.3",
39-
"typedoc": "^0.27.6",
40-
"typedoc-plugin-rename-defaults": "^0.7.2",
40+
"typedoc": "^0.28.14",
41+
"typedoc-plugin-markdown": "^4.0.0",
4142
"typescript": "^5.0.4",
4243
"webpack": "^5.97.1"
4344
},

0 commit comments

Comments
 (0)