chore(docs): add improvements (#191)

Co-authored-by: DominicGBauer <dominic@nomanini.com>
Co-authored-by: benitav <benita@journeyapps.com>

Author: 3 people

docs/README.md

@@ -4,12 +4,19 @@ This website is built using [Docusaurus 3](https://docusaurus.io/), a modern sta
 
 ### Installation
 
+In the root of the repo:
+
 ```bash
-pnpm
+pnpm install
+pnpm build:packages
 ```
 
 ### Local Development
 
+In this directory:
+
+Copy `.env.example` to `.env`.
+
 ```bash
 pnpm start
 ```

docs/docusaurus.config.ts

@@ -19,8 +19,11 @@ const plugins = Object.entries(packageMap).map(([id, config]) => [
     parametersFormat: 'table',
     propertiesFormat: 'table',
     enumMembersFormat: 'table',
+    excludeProtected: true,
+    excludePrivate: true,
     indexFormat: 'table',
     disableSources: true,
+    expandObjects: true,
     useCodeBlocks: true,
     typeDeclarationFormat: 'table',
     membersWithOwnFile: ['Class', 'Enum', 'Function', 'Interface'],

docs/package.json

@@ -9,25 +9,24 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "^3.2.1",
-    "@docusaurus/preset-classic": "^3.2.1",
+    "@docusaurus/core": "^3.3.2",
+    "@docusaurus/preset-classic": "^3.3.2",
     "@mdx-js/react": "^3.0.1",
-    "clsx": "^1.2.1",
     "dotenv": "^16.4.5",
     "prism-react-renderer": "^2.3.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^3.2.1",
-    "@docusaurus/theme-classic": "^3.2.1",
-    "@docusaurus/tsconfig": "3.2.1",
-    "@docusaurus/types": "3.2.1",
+    "@docusaurus/module-type-aliases": "^3.3.2",
+    "@docusaurus/theme-classic": "^3.3.2",
+    "@docusaurus/tsconfig": "3.3.2",
+    "@docusaurus/types": "3.3.2",
     "@types/node": "^20.12.5",
-    "docusaurus-plugin-typedoc": "^1.0.0next.28",
+    "docusaurus-plugin-typedoc": "^1.0.1",
     "typedoc": "^0.25.13",
-    "typedoc-plugin-markdown": "^4.0.0next.55",
-    "typescript": "~5.4.4"
+    "typedoc-plugin-markdown": "^4.0.2",
+    "typescript": "~5.4.5"
   },
   "browserslist": {
     "production": [

docs/src/css/custom.css

@@ -15,6 +15,7 @@
   --ifm-color-primary-lightest: #c44dff;
   --ifm-code-font-size: 95%;
   --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
+  --ifm-table-cell-padding: 0.4rem;
 }
 
 /* For readability concerns, you should choose a lighter palette in dark mode. */
@@ -28,3 +29,48 @@
   --ifm-color-primary-lightest: #e5b2ff;
   --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
 }
+
+/* Hide "return", "type parameters", and "inherited from" sections */
+#returns,
+#returns + p,
+#returns + p + table,
+#returns + p + p,
+#returns + p + p + table,
+#returns + div,
+#returns + div + table,
+[id^="returns-"],
+[id^="returns-"] + p,
+[id^="returns-"] + p + p,
+[id^="returns-"] + p + p,
+[id^="returns-"] + p + p + table,
+[id^="returns-"] + div,
+[id^="returns-"] + div + table,
+#type-parameters,
+#type-parameters + table,
+[id^="type-parameters-"],
+[id^="type-parameters-"] + table,
+#inherited-from,
+#inherited-from + p,
+[id^="inherited-from-"],
+[id^="inherited-from-"] + p {
+  display: none;
+}
+
+/* Expand parameter and enumeration tables to full width */
+#parameters + table,
+[id^="parameters-"] + table,
+#enumeration-members + table,
+[id^="enumeration-members-"] + table {
+  width: 100%;
+  table-layout: fixed;
+  display: table;
+}
+
+th {
+  text-transform: uppercase;
+  font-size: 80%;
+}
+
+table th {
+  color: #767676;
+}