From 7c892811fe92404ac3921093eefbc390809829bd Mon Sep 17 00:00:00 2001
From: Ayush Jhawar
Date: Sat, 11 Oct 2025 17:24:40 +0530
Subject: [PATCH 1/3] Add space above first para
---
src/css/custom.css | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/css/custom.css b/src/css/custom.css
index 1b4df3a..fdd47ea 100644
--- a/src/css/custom.css
+++ b/src/css/custom.css
@@ -601,7 +601,7 @@ article h4 {
}
.markdown > p:first-of-type {
- margin-bottom: 2rem !important;
+ margin-top: 2rem !important;
}
.skeleton-container {
From f5337a8e7985cfb3740b0ce3bcc67ca94becad9a Mon Sep 17 00:00:00 2001
From: Ayush Jhawar
Date: Sat, 11 Oct 2025 17:34:11 +0530
Subject: [PATCH 2/3] Add missing or incomplete descriptions
---
docs/advanced/units.md | 1 +
docs/command-line/tsci-export.md | 1 +
docs/contributing/overview-of-projects.md | 1 +
docs/contributing/the-contributor-handbook.md | 1 +
docs/footprints/silkscreencircle.mdx | 1 +
docs/footprints/silkscreenrect.mdx | 1 +
docs/intro/installation.md | 1 +
.../building-a-simple-usb-flashlight.mdx | 75 ++++++++++---------
docs/web-apis/datasheet-sdk.md | 1 +
docs/web-apis/jlcsearch-api.md | 1 +
10 files changed, 47 insertions(+), 37 deletions(-)
diff --git a/docs/advanced/units.md b/docs/advanced/units.md
index 028e50b..f506091 100644
--- a/docs/advanced/units.md
+++ b/docs/advanced/units.md
@@ -1,5 +1,6 @@
---
title: tscircuit Units
+description: Understanding default units in tscircuit for length, electrical properties, and other measurements.
---
In tscircuit you can specify a unit explicitly with a string e.g. "0.1mm", but
diff --git a/docs/command-line/tsci-export.md b/docs/command-line/tsci-export.md
index 580a39c..6101a9c 100644
--- a/docs/command-line/tsci-export.md
+++ b/docs/command-line/tsci-export.md
@@ -1,5 +1,6 @@
---
title: tsci export
+description: Export tscircuit files to various formats including SVG schematics, PCB layouts, and fabrication files.
---
import ImageWithCaption from "../../src/components/ImageWithCaption"
diff --git a/docs/contributing/overview-of-projects.md b/docs/contributing/overview-of-projects.md
index 877df76..c13af95 100644
--- a/docs/contributing/overview-of-projects.md
+++ b/docs/contributing/overview-of-projects.md
@@ -1,6 +1,7 @@
---
title: Overview of Projects
sidebar_position: 2
+description: Explore the key tscircuit repositories including core libraries, tools, and web components that power the ecosystem.
---
| Repo | Description | Open Issues |
diff --git a/docs/contributing/the-contributor-handbook.md b/docs/contributing/the-contributor-handbook.md
index c662c2c..60f9f4e 100644
--- a/docs/contributing/the-contributor-handbook.md
+++ b/docs/contributing/the-contributor-handbook.md
@@ -1,5 +1,6 @@
---
title: The Contributor Handbook
+description: Essential patterns and guidelines for contributing to tscircuit, including development tools and coding standards.
---
We have some important patterns that make contributing to
diff --git a/docs/footprints/silkscreencircle.mdx b/docs/footprints/silkscreencircle.mdx
index 4006b85..a91cc03 100644
--- a/docs/footprints/silkscreencircle.mdx
+++ b/docs/footprints/silkscreencircle.mdx
@@ -1,5 +1,6 @@
---
title:
+description: Silkscreen circles are often used to indicate "pin1" on a chip.
---
## Overview
diff --git a/docs/footprints/silkscreenrect.mdx b/docs/footprints/silkscreenrect.mdx
index 509a989..04b0571 100644
--- a/docs/footprints/silkscreenrect.mdx
+++ b/docs/footprints/silkscreenrect.mdx
@@ -1,5 +1,6 @@
---
title:
+description: Silkscreen rectangles can be used to encapsulate a rectangular area around a chip.
---
## Overview
diff --git a/docs/intro/installation.md b/docs/intro/installation.md
index 036bbcd..4417c53 100644
--- a/docs/intro/installation.md
+++ b/docs/intro/installation.md
@@ -1,6 +1,7 @@
---
title: Installation
sidebar_position: 2
+description: Install tscircuit CLI globally or per-project to start building electronic circuits with TypeScript.
---
## Dependencies
diff --git a/docs/tutorials/building-a-simple-usb-flashlight.mdx b/docs/tutorials/building-a-simple-usb-flashlight.mdx
index 208b0f7..e5b0204 100644
--- a/docs/tutorials/building-a-simple-usb-flashlight.mdx
+++ b/docs/tutorials/building-a-simple-usb-flashlight.mdx
@@ -1,37 +1,38 @@
----
-title: Building a Simple USB Flashlight
----
-
-## Overview
-
-This tutorial will walk you through building a simple USB flashlight using
-tscircuit.
-
-import TscircuitIframe from "@site/src/components/TscircuitIframe"
-
- {
- const USBCPort = useUsbC("USBC")
- const Button = usePushButton("SW1")
- return (
-
-
-
-
-
-
-
-
- )
-}
-`} />
\ No newline at end of file
+---
+title: Building a Simple USB Flashlight
+description: Learn how to build a simple USB-powered flashlight circuit using tscircuit with a push button, LED, and USB-C connector.
+---
+
+## Overview
+
+This tutorial will walk you through building a simple USB flashlight using
+tscircuit.
+
+import TscircuitIframe from "@site/src/components/TscircuitIframe"
+
+ {
+ const USBCPort = useUsbC("USBC")
+ const Button = usePushButton("SW1")
+ return (
+
+
+
+
+
+
+
+
+ )
+}
+`} />
\ No newline at end of file
diff --git a/docs/web-apis/datasheet-sdk.md b/docs/web-apis/datasheet-sdk.md
index fed6582..014431f 100644
--- a/docs/web-apis/datasheet-sdk.md
+++ b/docs/web-apis/datasheet-sdk.md
@@ -1,6 +1,7 @@
---
title: Retrieve datasheets with the SDK
sidebar_position: 5
+description: Use the @tscircuit/api SDK to programmatically retrieve and process component datasheets with pin information.
---
The [`@tscircuit/api`](https://github.com/tscircuit/api) package provides a
diff --git a/docs/web-apis/jlcsearch-api.md b/docs/web-apis/jlcsearch-api.md
index aa80cc1..22955e6 100644
--- a/docs/web-apis/jlcsearch-api.md
+++ b/docs/web-apis/jlcsearch-api.md
@@ -1,6 +1,7 @@
---
title: jlcsearch API
sidebar_position: 6
+description: Search and query JLCPCB in-stock components with the jlcsearch JSON API for scripting and integration.
---
# jlcsearch.tscircuit.com
From d8694a52c4d1df19c32755788eb3fce916f4d4e6 Mon Sep 17 00:00:00 2001
From: Ayush Jhawar
Date: Sat, 11 Oct 2025 18:35:30 +0530
Subject: [PATCH 3/3] Fix the Markdown Format while rendering
---
.../building-static-sites-with-tsci.mdx | 1 +
src/css/custom.css | 10 +++++++
src/theme/DocCard/index.tsx | 29 +++++++++++++++----
3 files changed, 34 insertions(+), 6 deletions(-)
diff --git a/docs/guides/running-tscircuit/building-static-sites-with-tsci.mdx b/docs/guides/running-tscircuit/building-static-sites-with-tsci.mdx
index 8ba184b..f299ef4 100644
--- a/docs/guides/running-tscircuit/building-static-sites-with-tsci.mdx
+++ b/docs/guides/running-tscircuit/building-static-sites-with-tsci.mdx
@@ -1,5 +1,6 @@
---
title: Building a Static Site
+description: "`tsci build --site` packages your tscircuit project into a static website that anyone can browse without running a server."
---
`tsci build --site` packages your tscircuit project into a static website that anyone can browse without running a server. The command evaluates your circuits, exports the generated assets into a `dist` folder, and wires them up to the tscircuit RunFrame viewer so visitors can flip between PCB, schematic, and 3D previews right in the browser.
diff --git a/src/css/custom.css b/src/css/custom.css
index fdd47ea..f77a764 100644
--- a/src/css/custom.css
+++ b/src/css/custom.css
@@ -732,6 +732,16 @@ article h4 {
font-size: 1rem !important;
}
+/* Allow inline code styling in overview pages */
+[class*="generatedIndexPage"] p code {
+ all: revert !important;
+ background: var(--ifm-code-background) !important;
+ border-radius: 3px !important;
+ font-family: var(--ifm-font-family-monospace) !important;
+ padding: var(--ifm-code-padding-vertical) var(--ifm-code-padding-horizontal) !important;
+ font-size: 0.9em !important;
+}
+
/* Add colon separator between heading and description */
[class*="generatedIndexPage"] h2::after {
content: ": " !important;
diff --git a/src/theme/DocCard/index.tsx b/src/theme/DocCard/index.tsx
index 967e42f..bb2291a 100644
--- a/src/theme/DocCard/index.tsx
+++ b/src/theme/DocCard/index.tsx
@@ -79,13 +79,24 @@ function CardLayout({
className={clsx("text--truncate", styles.cardDescription)}
title={description}
>
- {description}
+ {parseInlineMarkdown(description)}
)}
)
}
+function parseInlineMarkdown(text: string): ReactNode[] {
+ // Convert inline code (backticks) to elements
+ const parts = text.split(/(`[^`]+`)/g)
+ return parts.map((part, i) => {
+ if (part.startsWith("`") && part.endsWith("`")) {
+ return {part.slice(1, -1)}
+ }
+ return {part}
+ })
+}
+
function NestedItem({
item,
}: { item: PropSidebarItemLink | PropSidebarItemCategory }) {
@@ -95,11 +106,15 @@ function NestedItem({
return (
- {item.label}
+
+ {parseInlineMarkdown(item.label)}
+
{description && (
<>
:
- {description}
+
+ {parseInlineMarkdown(description)}
+
>
)}
@@ -110,12 +125,14 @@ function NestedItem({
return subHref ? (
- {item.label}
+
+ {parseInlineMarkdown(item.label)}
+
{item.description && (
<>
:
- {item.description}
+ {parseInlineMarkdown(item.description)}
>
)}
@@ -148,7 +165,7 @@ function CardCategory({ item }: { item: PropSidebarItemCategory }): ReactNode {
className={clsx("text--truncate", styles.cardDescription)}
title={item.description}
>
- {item.description}
+ {parseInlineMarkdown(item.description)}
)}
{item.items.length > 0 && (