From 08f8e3b4a4879dd7c91c16fbce80c4f2bc5e357f Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Mon, 10 Jul 2023 02:32:24 +0000
Subject: [PATCH] docs + various polish
---
quartz/components/TableOfContents.tsx | 75 ++++++++++++++++++++++++-------------
1 files changed, 49 insertions(+), 26 deletions(-)
diff --git a/quartz/components/TableOfContents.tsx b/quartz/components/TableOfContents.tsx
index 19f26ef..ddd5195 100644
--- a/quartz/components/TableOfContents.tsx
+++ b/quartz/components/TableOfContents.tsx
@@ -1,38 +1,61 @@
import { QuartzComponentConstructor, QuartzComponentProps } from "./types"
-import style from "./styles/toc.scss"
+import legacyStyle from "./styles/legacyToc.scss"
+import modernStyle from "./styles/toc.scss"
+// @ts-ignore
+import script from "./scripts/toc.inline"
interface Options {
- layout: 'modern' | 'quartz-3'
+ layout: 'modern' | 'legacy'
}
const defaultOptions: Options = {
- layout: 'quartz-3'
+ layout: 'modern'
}
+function TableOfContents({ fileData }: QuartzComponentProps) {
+ if (!fileData.toc) {
+ return null
+ }
+
+ return <div class="desktop-only">
+ <button type="button" id="toc">
+ <h3>Table of Contents</h3>
+ <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="fold">
+ <polyline points="6 9 12 15 18 9"></polyline>
+ </svg>
+ </button>
+ <div id="toc-content">
+ <ul class="overflow">
+ {fileData.toc.map(tocEntry => <li key={tocEntry.slug} class={`depth-${tocEntry.depth}`}>
+ <a href={`#${tocEntry.slug}`} data-for={tocEntry.slug}>{tocEntry.text}</a>
+ </li>)}
+ </ul>
+ </div>
+ </div>
+}
+TableOfContents.css = modernStyle
+TableOfContents.afterDOMLoaded = script
+
+function LegacyTableOfContents({ fileData }: QuartzComponentProps) {
+ if (!fileData.toc) {
+ return null
+ }
+
+ return <details id="toc" open>
+ <summary>
+ <h3>Table of Contents</h3>
+ </summary>
+ <ul>
+ {fileData.toc.map(tocEntry => <li key={tocEntry.slug} class={`depth-${tocEntry.depth}`}>
+ <a href={`#${tocEntry.slug}`} data-for={tocEntry.slug}>{tocEntry.text}</a>
+ </li>)}
+ </ul>
+ </details>
+}
+LegacyTableOfContents.css = legacyStyle
+
export default ((opts?: Partial<Options>) => {
const layout = opts?.layout ?? defaultOptions.layout
- if (layout === "modern") {
- return function() {
- return null // TODO (make this look like nextra)
- }
- } else {
- function TableOfContents({ fileData }: QuartzComponentProps) {
- if (!fileData.toc) {
- return null
- }
-
- return <details class="toc" open>
- <summary><h3>Table of Contents</h3></summary>
- <ul>
- {fileData.toc.map(tocEntry => <li key={tocEntry.slug} class={`depth-${tocEntry.depth}`}>
- <a href={`#${tocEntry.slug}`}>{tocEntry.text}</a>
- </li>)}
- </ul>
- </details>
- }
-
- TableOfContents.css = style
- return TableOfContents
- }
+ return layout === "modern" ? TableOfContents : LegacyTableOfContents
}) satisfies QuartzComponentConstructor
--
Gitblit v1.10.0