From adec32227f998755f48138ec89df8cabd1f48e14 Mon Sep 17 00:00:00 2001 From: Jacky Zhao Date: Sat, 22 Jul 2023 17:27:41 -0700 Subject: [PATCH] run prettier --- .github/ISSUE_TEMPLATE/bug_report.md | 13 +- .github/ISSUE_TEMPLATE/feature_request.md | 5 +- .github/workflows/ci.yaml | 4 +- CODE_OF_CONDUCT.md | 41 +- content/advanced/creating components.md | 2 +- content/advanced/making plugins.md | 3 +- content/configuration.md | 51 +-- content/features/Latex.md | 10 +- content/features/Mermaid diagrams.md | 2 +- content/features/SPA Routing.md | 2 +- content/features/backlinks.md | 5 +- content/features/callouts.md | 21 +- content/features/full-text search.md | 10 +- content/features/graph view.md | 23 +- content/features/index.md | 2 +- content/features/popover previews.md | 3 +- content/features/syntax highlighting.md | 19 +- content/features/table of contents.md | 4 +- content/features/upcoming features.md | 10 +- content/index.md | 4 +- content/philosophy.md | 4 +- content/tags/component.md | 2 +- globals.d.ts | 8 +- index.d.ts | 4 +- quartz.config.ts | 75 ++-- quartz/bootstrap-cli.mjs | 349 ++++++++++-------- quartz/bootstrap-worker.mjs | 4 +- quartz/build.ts | 78 ++-- quartz/cfg.ts | 40 +- quartz/components/Backlinks.tsx | 28 +- quartz/components/Body.tsx | 9 +- quartz/components/Darkmode.tsx | 80 ++-- quartz/components/Date.tsx | 4 +- quartz/components/Footer.tsx | 24 +- quartz/components/Graph.tsx | 63 ++-- quartz/components/Head.tsx | 40 +- quartz/components/Header.tsx | 4 +- quartz/components/PageList.tsx | 61 +-- quartz/components/PageTitle.tsx | 6 +- quartz/components/ReadingTime.tsx | 6 +- quartz/components/Search.tsx | 50 ++- quartz/components/TableOfContents.tsx | 75 ++-- quartz/components/TagList.tsx | 24 +- quartz/components/index.ts | 6 +- quartz/components/pages/Content.tsx | 4 +- quartz/components/pages/FolderContent.tsx | 26 +- quartz/components/pages/TagContent.tsx | 24 +- quartz/components/renderPage.tsx | 124 ++++--- quartz/components/scripts/callout.inline.ts | 4 +- quartz/components/scripts/darkmode.inline.ts | 25 +- quartz/components/scripts/graph.inline.ts | 78 ++-- quartz/components/scripts/plausible.inline.ts | 2 +- quartz/components/scripts/popover.inline.ts | 30 +- quartz/components/scripts/search.inline.ts | 52 +-- quartz/components/scripts/spa.inline.ts | 63 ++-- quartz/components/scripts/toc.inline.ts | 4 +- quartz/components/scripts/util.ts | 2 +- quartz/components/styles/graph.scss | 6 +- quartz/components/styles/legacyToc.scss | 2 +- quartz/components/styles/listPage.scss | 2 +- quartz/components/styles/popover.scss | 9 +- quartz/components/styles/search.scss | 10 +- quartz/components/styles/toc.scss | 11 +- quartz/components/types.ts | 16 +- quartz/log.ts | 2 +- quartz/path.test.ts | 170 +++++---- quartz/path.ts | 78 ++-- quartz/perf.ts | 8 +- quartz/plugins/emitters/aliases.ts | 14 +- quartz/plugins/emitters/contentIndex.ts | 42 ++- quartz/plugins/emitters/contentPage.tsx | 19 +- quartz/plugins/emitters/folderPage.tsx | 45 +-- quartz/plugins/emitters/index.ts | 10 +- quartz/plugins/emitters/tagPage.tsx | 29 +- quartz/plugins/filters/draft.ts | 2 +- quartz/plugins/filters/explicit.ts | 2 +- quartz/plugins/filters/index.ts | 4 +- quartz/plugins/index.ts | 49 +-- quartz/plugins/transformers/description.ts | 22 +- quartz/plugins/transformers/frontmatter.ts | 27 +- quartz/plugins/transformers/gfm.ts | 29 +- quartz/plugins/transformers/index.ts | 18 +- quartz/plugins/transformers/lastmod.ts | 14 +- quartz/plugins/transformers/latex.ts | 44 +-- quartz/plugins/transformers/links.ts | 160 ++++---- quartz/plugins/transformers/ofm.ts | 112 +++--- quartz/plugins/transformers/syntax.ts | 13 +- quartz/plugins/transformers/toc.ts | 64 ++-- quartz/plugins/types.ts | 26 +- quartz/plugins/vfile.ts | 6 +- quartz/processors/emit.ts | 57 ++- quartz/processors/filter.ts | 8 +- quartz/processors/parse.ts | 87 +++-- quartz/resources.tsx | 37 +- quartz/styles/base.scss | 49 ++- quartz/styles/callouts.scss | 138 +++---- quartz/styles/variables.scss | 2 +- quartz/theme.ts | 25 +- quartz/trace.ts | 8 +- quartz/worker.ts | 7 +- tsconfig.json | 16 +- 101 files changed, 1810 insertions(+), 1405 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 189648d9..7f1576df 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,10 +1,9 @@ --- name: Bug report about: Something about Quartz isn't working the way you expect -title: '' +title: "" labels: bug -assignees: '' - +assignees: "" --- **Describe the bug** @@ -12,6 +11,7 @@ A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: + 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' @@ -24,9 +24,10 @@ A clear and concise description of what you expected to happen. If applicable, add screenshots to help explain your problem. **Desktop (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] + +- Device: [e.g. iPhone6] +- OS: [e.g. iOS] +- Browser [e.g. chrome, safari] **Additional context** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 2c9c226d..e766b49b 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,10 +1,9 @@ --- name: Feature request about: Suggest an idea or improvement for Quartz -title: '' +title: "" labels: enhancement -assignees: '' - +assignees: "" --- **Is your feature request related to a problem? Please describe.** diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 2a6e70c6..2bc953b9 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -1,4 +1,4 @@ -name: Build and Test +name: Build and Test on: push: @@ -34,4 +34,4 @@ jobs: run: npm test - name: Ensure Quartz builds - run: npx quartz build + run: npx quartz build diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index c624fd59..887a2c44 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -20,28 +20,28 @@ If you see someone who is making an extra effort to ensure our community is welc The following behaviors are expected and requested of all community members: - * Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community. - * Exercise consideration and respect in your speech and actions. - * Attempt collaboration before conflict. - * Refrain from demeaning, discriminatory, or harassing behavior and speech. - * Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential. - * Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations. +- Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community. +- Exercise consideration and respect in your speech and actions. +- Attempt collaboration before conflict. +- Refrain from demeaning, discriminatory, or harassing behavior and speech. +- Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential. +- Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations. ## 4. Unacceptable Behavior The following behaviors are considered harassment and are unacceptable within our community: - * Violence, threats of violence or violent language directed against another person. - * Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language. - * Posting or displaying sexually explicit or violent material. - * Posting or threatening to post other people's personally identifying information ("doxing"). - * Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability. - * Inappropriate photography or recording. - * Inappropriate physical contact. You should have someone's consent before touching them. - * Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances. - * Deliberate intimidation, stalking or following (online or in person). - * Advocating for, or encouraging, any of the above behavior. - * Sustained disruption of community events, including talks and presentations. +- Violence, threats of violence or violent language directed against another person. +- Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language. +- Posting or displaying sexually explicit or violent material. +- Posting or threatening to post other people's personally identifying information ("doxing"). +- Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability. +- Inappropriate photography or recording. +- Inappropriate physical contact. You should have someone's consent before touching them. +- Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances. +- Deliberate intimidation, stalking or following (online or in person). +- Advocating for, or encouraging, any of the above behavior. +- Sustained disruption of community events, including talks and presentations. ## 5. Weapons Policy @@ -59,14 +59,11 @@ If a community member engages in unacceptable behavior, the community organizers If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. j.zhao2k19@gmail.com. - - Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe. In the context of in-person events, organizers will also provide escorts as desired by the person experiencing distress. ## 8. Addressing Grievances -If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify @jackyzha0 with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies. - +If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify @jackyzha0 with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies. ## 9. Scope @@ -80,7 +77,7 @@ j.zhao2k19@gmail.com ## 11. License and attribution -The Citizen Code of Conduct is distributed by [Stumptown Syndicate](http://stumptownsyndicate.org) under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/). +The Citizen Code of Conduct is distributed by [Stumptown Syndicate](http://stumptownsyndicate.org) under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/). Portions of text derived from the [Django Code of Conduct](https://www.djangoproject.com/conduct/) and the [Geek Feminism Anti-Harassment Policy](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy). diff --git a/content/advanced/creating components.md b/content/advanced/creating components.md index f2fa6358..9467ef8a 100644 --- a/content/advanced/creating components.md +++ b/content/advanced/creating components.md @@ -2,4 +2,4 @@ title: Creating your own Quartz components --- -See the [component listing](/tags/component) for a full-list of the Quartz built-in components. \ No newline at end of file +See the [component listing](/tags/component) for a full-list of the Quartz built-in components. diff --git a/content/advanced/making plugins.md b/content/advanced/making plugins.md index bdd91943..661b5162 100644 --- a/content/advanced/making plugins.md +++ b/content/advanced/making plugins.md @@ -5,6 +5,7 @@ title: Making your own plugins This part of the documentation will assume you have some basic coding knowledge and will include code snippets that describe the interface of what Quartz plugins should look like. ## Transformers + ```ts export type QuartzTransformerPluginInstance = { name: string @@ -17,4 +18,4 @@ export type QuartzTransformerPluginInstance = { ## Filters -## Emitters \ No newline at end of file +## Emitters diff --git a/content/configuration.md b/content/configuration.md index 21d11ebe..9f103f4a 100644 --- a/content/configuration.md +++ b/content/configuration.md @@ -2,7 +2,7 @@ title: Configuration --- -Quartz is meant to be extremely configurable, even if you don't know any coding. Most of the configuration you should need can be done by just editing `quartz.config.ts`. +Quartz is meant to be extremely configurable, even if you don't know any coding. Most of the configuration you should need can be done by just editing `quartz.config.ts`. If you edit this file using a text-editor that has TypeScript language support like VSCode, it will warn you when you you've made an error in your configuration. @@ -16,33 +16,35 @@ const config: QuartzConfig = { ``` ## General Configuration + This part of the configuration concerns anything that can affect the whole site. The following is a list breaking down all the things you can configure: - `pageTitle`: used as an anchor to return to the home page. This is also used when generating the [[RSS Feed]] for your site. - `enableSPA`: whether to enable [[SPA Routing]] on your site. - `enablePopovers`: whether to enable [[popover previews]] on your site. -- `analytics`: what to use for analytics on your site. Values can be - - `null`: don't use analytics; - - `{ provider: 'plausible' }`: use [Plausible](https://plausible.io/), a privacy-friendly alternative to Google Analytics; or - - `{ provider: 'google', tagId: }`: use Google Analytics -- `caononicalUrl`: sometimes called `baseURL` in other site generators. This is used for sitemaps and RSS feeds that require an absolute URL to know where the canonical 'home' of your site lives. This is normally the deployed URL of your site (e.g. `https://quartz.jzhao.xyz/` for this site). Note that Quartz 4 will avoid using this as much as possible and use relative URLs whenever it can to make sure your site works no matter *where* you end up actually deploying it. -- `ignorePatterns`: a list of [glob](https://en.wikipedia.org/wiki/Glob_(programming)) patterns that Quartz should ignore and not search through when looking for files inside the `content` folder. +- `analytics`: what to use for analytics on your site. Values can be + - `null`: don't use analytics; + - `{ provider: 'plausible' }`: use [Plausible](https://plausible.io/), a privacy-friendly alternative to Google Analytics; or + - `{ provider: 'google', tagId: }`: use Google Analytics +- `caononicalUrl`: sometimes called `baseURL` in other site generators. This is used for sitemaps and RSS feeds that require an absolute URL to know where the canonical 'home' of your site lives. This is normally the deployed URL of your site (e.g. `https://quartz.jzhao.xyz/` for this site). Note that Quartz 4 will avoid using this as much as possible and use relative URLs whenever it can to make sure your site works no matter _where_ you end up actually deploying it. +- `ignorePatterns`: a list of [glob]() patterns that Quartz should ignore and not search through when looking for files inside the `content` folder. - `theme`: configure how the site looks. - - `typography`: what fonts to use. Any font available on [Google Fonts](https://fonts.google.com/) works here. - - `header`: Font to use for headers - - `code`: Font for inline and block quotes. - - `body`: Font for everything - - `colors`: controls the theming of the site. - - `light`: page background - - `lightgray`: borders - - `gray`: graph links, heavier borders - - `darkgray`: body text - - `dark`: header text and icons - - `secondary`: link colour, current [[graph view|graph]] node - - `tertiary`: hover states and visited [[graph view|graph]] nodes - - `highlight`: internal link background, highlighted text, [[syntax highlighting|highlighted lines of code]] + - `typography`: what fonts to use. Any font available on [Google Fonts](https://fonts.google.com/) works here. + - `header`: Font to use for headers + - `code`: Font for inline and block quotes. + - `body`: Font for everything + - `colors`: controls the theming of the site. + - `light`: page background + - `lightgray`: borders + - `gray`: graph links, heavier borders + - `darkgray`: body text + - `dark`: header text and icons + - `secondary`: link colour, current [[graph view|graph]] node + - `tertiary`: hover states and visited [[graph view|graph]] nodes + - `highlight`: internal link background, highlighted text, [[syntax highlighting|highlighted lines of code]] ## Plugins + You can think of Quartz plugins as a series of transformations over content. ![[quartz-transform-pipeline.png]] @@ -62,18 +64,19 @@ plugins: { By adding, removing, and reordering plugins from the `tranformers`, `filters`, and `emitters` fields, you can customize the behaviour of Quartz. > [!note] -> Each node is modified by every transformer *in order*. Some transformers are position-sensitive so you may need to take special note of whether it needs come before or after any other particular plugins. +> Each node is modified by every transformer _in order_. Some transformers are position-sensitive so you may need to take special note of whether it needs come before or after any other particular plugins. Additionally, plugins may also have their own configuration settings that you can pass in. For example, the [[Latex]] plugin allows you to pass in a field specifying the `renderEngine` to choose between Katex and MathJax. ```ts transformers: [ - Plugin.FrontMatter(), // uses default options - Plugin.Latex({ renderEngine: 'katex' }) // specify some options + Plugin.FrontMatter(), // uses default options + Plugin.Latex({ renderEngine: "katex" }), // specify some options ] ``` ### Layout -Certain emitters may also output [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) files. To make sure that + +Certain emitters may also output [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) files. To make sure that ### Components diff --git a/content/features/Latex.md b/content/features/Latex.md index 04bc366e..3f523d64 100644 --- a/content/features/Latex.md +++ b/content/features/Latex.md @@ -3,6 +3,7 @@ Quartz uses [Katex](https://katex.org/) by default to typeset both inline and bl ## Formatting ### Block Math + Block math can be rendered by delimiting math expression with `$$`. ``` @@ -20,20 +21,25 @@ f(x) = \int_{-\infty}^\infty $$ ### Inline Math + Similarly, inline math can be rendered by delimiting math expression with a single `$`. For example, `$e^{i\pi} = -1$` produces $e^{i\pi} = -1$ ### Escaping symbols -There will be cases where you may have more than one `$` in a paragraph at once which may accidentally trigger MathJax/Katex. + +There will be cases where you may have more than one `$` in a paragraph at once which may accidentally trigger MathJax/Katex. To get around this, you can escape the dollar sign by doing `\$` instead. For example: + - Incorrect: `I have $1 and you have $2` produces I have $1 and you have $2 - Correct: `I have \$1 and you have \$2` produces I have \$1 and you have \$2 ## MathJax + In `quartz.config.ts`, you can configure Quartz to use [MathJax SVG rendering](https://docs.mathjax.org/en/latest/output/svg.html) by replacing `Plugin.Latex({ renderEngine: 'katex' })` with `Plugin.Latex({ renderEngine: 'mathjax' })` ## Customization + - Removing Latex support: remove all instances of `Plugin.Latex()` from `quartz.config.ts`. -- Plugin: `quartz/plugins/transformers/latex.ts` \ No newline at end of file +- Plugin: `quartz/plugins/transformers/latex.ts` diff --git a/content/features/Mermaid diagrams.md b/content/features/Mermaid diagrams.md index 2d434064..91d0988b 100644 --- a/content/features/Mermaid diagrams.md +++ b/content/features/Mermaid diagrams.md @@ -1,5 +1,5 @@ > [!warning] -> Wondering why Mermaid diagrams may not be showing up even if you have them enabled? You may need to reorder your plugins so that `Plugin.ObsidianFlavoredMarkdown()` is *after* `Plugin.SyntaxHighlighting()`. +> Wondering why Mermaid diagrams may not be showing up even if you have them enabled? You may need to reorder your plugins so that `Plugin.ObsidianFlavoredMarkdown()` is _after_ `Plugin.SyntaxHighlighting()`. ```mermaid sequenceDiagram diff --git a/content/features/SPA Routing.md b/content/features/SPA Routing.md index e46b4c72..91249939 100644 --- a/content/features/SPA Routing.md +++ b/content/features/SPA Routing.md @@ -1 +1 @@ -Single-page-app style rendering. This prevents flashes of unstyled content and improves smoothness of Quartz \ No newline at end of file +Single-page-app style rendering. This prevents flashes of unstyled content and improves smoothness of Quartz diff --git a/content/features/backlinks.md b/content/features/backlinks.md index b889e3b8..4df7fd17 100644 --- a/content/features/backlinks.md +++ b/content/features/backlinks.md @@ -1,13 +1,14 @@ --- title: Backlinks tags: -- component + - component --- A backlink for a note is a link from another note to that note. Links in the backlink pane also feature rich [[popover previews]] if you have that feature enabled. ## Customization + - Removing backlinks: delete all usages of `Component.Backlinks()` from `quartz.config.ts`. - Component: `quartz/components/Backlinks.tsx` - Style: `quartz/components/styles/backlinks.scss` -- Script: `quartz/components/scripts/search.inline.ts` \ No newline at end of file +- Script: `quartz/components/scripts/search.inline.ts` diff --git a/content/features/callouts.md b/content/features/callouts.md index 6f33dff7..cb5feb9d 100644 --- a/content/features/callouts.md +++ b/content/features/callouts.md @@ -3,15 +3,16 @@ title: Callouts --- > [!warning] -> Wondering why callouts may not be showing up even if you have them enabled? You may need to reorder your plugins so that `Plugin.ObsidianFlavoredMarkdown()` is *after* `Plugin.SyntaxHighlighting()`. - +> Wondering why callouts may not be showing up even if you have them enabled? You may need to reorder your plugins so that `Plugin.ObsidianFlavoredMarkdown()` is _after_ `Plugin.SyntaxHighlighting()`. > [!info] > Default title > [!question]+ Can callouts be nested? +> > > [!todo]- Yes!, they can. -> > > [!example] You can even use multiple layers of nesting. +> > +> > > [!example] You can even use multiple layers of nesting. > [!EXAMPLE] Examples > @@ -21,31 +22,31 @@ title: Callouts > > Aliases: note -> [!abstract] Summaries +> [!abstract] Summaries > > Aliases: abstract, summary, tldr -> [!info] Info +> [!info] Info > > Aliases: info, todo -> [!tip] Hint +> [!tip] Hint > > Aliases: tip, hint, important -> [!success] Success +> [!success] Success > > Aliases: success, check, done -> [!question] Question +> [!question] Question > > Aliases: question, help, faq -> [!warning] Warning +> [!warning] Warning > > Aliases: warning, caution, attention -> [!failure] Failure +> [!failure] Failure > > Aliases: failure, fail, missing diff --git a/content/features/full-text search.md b/content/features/full-text search.md index 376e4674..cb0567f3 100644 --- a/content/features/full-text search.md +++ b/content/features/full-text search.md @@ -1,12 +1,12 @@ --- title: Full-text Search -tags: -- component +tags: + - component --- Full-text search in Quartz is powered by [Flexsearch](https://github.com/nextapps-de/flexsearch). It's fast enough to return search results in under 10ms for Quartzs as large as half a million words. -It can be opened by either clicking on the search bar or pressing ⌘+K. The top 5 search results are shown on each query. Matching subterms are highlighted and the most relevant 30 words are excerpted. Clicking on a search result will navigate to that page. +It can be opened by either clicking on the search bar or pressing ⌘+K. The top 5 search results are shown on each query. Matching subterms are highlighted and the most relevant 30 words are excerpted. Clicking on a search result will navigate to that page. This component is also keyboard accessible: Tab and Shift+Tab will cycle forward and backward through search results and Enter will navigate to the highlighted result (first result by default). @@ -14,13 +14,15 @@ This component is also keyboard accessible: Tab and Shift+Tab will cycle forward > Search requires the `ContentIndex` emitter plugin to be present in the [[configuration]]. ### Indexing Behaviour + By default, it indexes every page on the site with **Markdown syntax removed**. This means link URLs for instance are not indexed. It properly tokenizes Chinese, Korean, and Japenese characters and constructs separate indexes for the title and content, weighing title matches above content matches. ## Customization + - Removing search: delete all usages of `Component.Search()` from `quartz.config.ts`. - Component: `quartz/components/Search.tsx` - Style: `quartz/components/styles/search.scss` - Script: `quartz/components/scripts/search.inline.ts` - - You can edit `contextWindowWords` or `numSearchResults` to suit your needs + - You can edit `contextWindowWords` or `numSearchResults` to suit your needs diff --git a/content/features/graph view.md b/content/features/graph view.md index 5b719503..9fb31be7 100644 --- a/content/features/graph view.md +++ b/content/features/graph view.md @@ -1,13 +1,13 @@ --- title: "Graph View" tags: -- component + - component --- -Quartz features a graph-view that can show both a local graph view and a global graph view. +Quartz features a graph-view that can show both a local graph view and a global graph view. -- The local graph view shows files that either link to the current file or are linked from the current file. In other words, it shows all notes that are *at most* one hop away. -- The global graph view can be toggled by clicking the graph icon on the top-right of the local graph view. It shows *all* the notes in your graph and how they connect to each other. +- The local graph view shows files that either link to the current file or are linked from the current file. In other words, it shows all notes that are _at most_ one hop away. +- The global graph view can be toggled by clicking the graph icon on the top-right of the local graph view. It shows _all_ the notes in your graph and how they connect to each other. By default, the node radius is proportional to the total number of incoming and outgoing internal links from that file. @@ -17,6 +17,7 @@ Additionally, similar to how browsers highlight visited links a different colour > Graph View requires the `ContentIndex` emitter plugin to be present in the [[configuration]]. ## Customization + Most configuration can be done by passing in options to `Component.Graph()`. For example, here's what the default configuration looks like: @@ -26,13 +27,13 @@ Component.Graph({ localGraph: { drag: true, // whether to allow panning the view around zoom: true, // whether to allow zooming in and out - depth: 1, // how many hops of notes to display + depth: 1, // how many hops of notes to display scale: 1.1, // default view scale - repelForce: 0.5, // how much nodes should repel each other + repelForce: 0.5, // how much nodes should repel each other centerForce: 0.3, // how much force to use when trying to center the nodes linkDistance: 30, // how long should the links be by default? - fontSize: 0.6, // what size should the node labels be? - opacityScale: 1 // how quickly do we fade out the labels when zooming out? + fontSize: 0.6, // what size should the node labels be? + opacityScale: 1, // how quickly do we fade out the labels when zooming out? }, globalGraph: { drag: true, @@ -43,8 +44,8 @@ Component.Graph({ centerForce: 0.3, linkDistance: 30, fontSize: 0.6, - opacityScale: 1 - } + opacityScale: 1, + }, }) ``` @@ -55,4 +56,4 @@ Want to customize it even more? - Removing graph view: delete all usages of `Component.Graph()` from `quartz.config.ts`. - Component: `quartz/components/Graph.tsx` - Style: `quartz/components/styles/graph.scss` -- Script: `quartz/components/scripts/graph.inline.ts` \ No newline at end of file +- Script: `quartz/components/scripts/graph.inline.ts` diff --git a/content/features/index.md b/content/features/index.md index 05bb9cd4..2997b3aa 100644 --- a/content/features/index.md +++ b/content/features/index.md @@ -1,3 +1,3 @@ --- title: Feature List ---- \ No newline at end of file +--- diff --git a/content/features/popover previews.md b/content/features/popover previews.md index 5eb69a4f..7bf608e0 100644 --- a/content/features/popover previews.md +++ b/content/features/popover previews.md @@ -9,6 +9,7 @@ By default, Quartz only fetches previews for pages inside your vault due to [COR When [[creating components|creating your own components]], you can include this `popover-hint` class to also include it in the popover. ## Configuration + - Remove popovers: set the `enablePopovers` field in `quartz.config.ts` to be `false`. - Style: `quartz/components/styles/popover.scss` -- Script: `quartz/components/scripts/popover.inline.ts` \ No newline at end of file +- Script: `quartz/components/scripts/popover.inline.ts` diff --git a/content/features/syntax highlighting.md b/content/features/syntax highlighting.md index 8f06eaea..16d3fa97 100644 --- a/content/features/syntax highlighting.md +++ b/content/features/syntax highlighting.md @@ -12,6 +12,7 @@ In short, it generates HTML that looks exactly like your code in an editor like > Syntax highlighting does have an impact on build speed if you have a lot of code snippets in your notes. ## Formatting + Text inside `backticks` on a line will be formatted like code. ```` @@ -37,11 +38,12 @@ export function trimPathSuffix(fp: string): string { ``` ### Titles + Add a file title to your code block, with text inside double quotes (`""`): ```` ```js title="..." - + ``` ```` @@ -56,11 +58,12 @@ export function trimPathSuffix(fp: string): string { ``` ### Line highlighting + Place a numeric range inside `{}`. ```` ```js {1-3,4} - + ``` ```` @@ -75,6 +78,7 @@ export function trimPathSuffix(fp: string): string { ``` ### Word highlighting + A series of characters, like a literal regex. ```` @@ -85,16 +89,17 @@ const [name, setName] = useState('Taylor'); ```` ```js /useState/ -const [age, setAge] = useState(50); -const [name, setName] = useState('Taylor'); +const [age, setAge] = useState(50) +const [name, setName] = useState("Taylor") ``` ### Line numbers + Syntax highlighting has line numbers configured automatically. If you want to start line numbers at a specific number, use `showLineNumbers{number}`: ```` ```js showLineNumbers{number} - + ``` ```` @@ -109,6 +114,7 @@ export function trimPathSuffix(fp: string): string { ``` ### Escaping code blocks + You can format a codeblock inside of a codeblock by wrapping it with another level of backtick fences that has one more backtick than the previous fence. ````` @@ -121,6 +127,7 @@ const [name, setName] = useState('Taylor'); ````` ## Customization + - Removing syntax highlighting: delete all usages of `Plugin.SyntaxHighlighting()` from `quartz.config.ts`. - Style: By default, Quartz uses derivatives of the GitHub light and dark themes. You can customize the colours in the `quartz/styles/syntax.scss` file. -- Plugin: `quartz/plugins/transformers/syntax.ts` \ No newline at end of file +- Plugin: `quartz/plugins/transformers/syntax.ts` diff --git a/content/features/table of contents.md b/content/features/table of contents.md index 54457710..70191157 100644 --- a/content/features/table of contents.md +++ b/content/features/table of contents.md @@ -1,5 +1,5 @@ --- title: "Table of Contents" tags: -- component ---- \ No newline at end of file + - component +--- diff --git a/content/features/upcoming features.md b/content/features/upcoming features.md index 31bbc4e0..6d39bb7b 100644 --- a/content/features/upcoming features.md +++ b/content/features/upcoming features.md @@ -12,9 +12,9 @@ draft: true - custom md blocks (e.g. for poetry) - sidenotes? [https://github.com/capnfabs/paperesque](https://github.com/capnfabs/paperesque) - watch mode - - watch for markdown changes and quartz config changes - - markdown changes only involve processing that single markdown file (at least for parsing) and then rerunning the filter and emitters - - config changes rebuild the whole thing + - watch for markdown changes and quartz config changes + - markdown changes only involve processing that single markdown file (at least for parsing) and then rerunning the filter and emitters + - config changes rebuild the whole thing - direct match in search using double quotes - attachments path - [https://help.obsidian.md/Advanced+topics/Using+Obsidian+URI](https://help.obsidian.md/Advanced+topics/Using+Obsidian+URI) @@ -26,8 +26,8 @@ draft: true - audio/video embed styling - Canvas - mermaid styling: [https://mermaid.js.org/config/theming.html#theme-variables-reference-table](https://mermaid.js.org/config/theming.html#theme-variables-reference-table) - - [https://github.com/jackyzha0/quartz/issues/331](https://github.com/jackyzha0/quartz/issues/331) + - [https://github.com/jackyzha0/quartz/issues/331](https://github.com/jackyzha0/quartz/issues/331) - block links: [https://help.obsidian.md/Linking+notes+and+files/Internal+links#Link+to+a+block+in+a+note](https://help.obsidian.md/Linking+notes+and+files/Internal+links#Link+to+a+block+in+a+note) - note/header/block transcludes: [https://help.obsidian.md/Linking+notes+and+files/Embedding+files](https://help.obsidian.md/Linking+notes+and+files/Embedding+files) - parse all images in page: use this for page lists if applicable? -- CV mode? with print stylesheet \ No newline at end of file +- CV mode? with print stylesheet diff --git a/content/index.md b/content/index.md index ff51dabc..8e012fa3 100644 --- a/content/index.md +++ b/content/index.md @@ -5,6 +5,7 @@ title: Welcome to Quartz 4 Quartz is a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites. Thousands of students, developers, and teachers are [[showcase|already using Quartz]] to publish personal notes, wikis, and [digital gardens](https://jzhao.xyz/posts/networked-thought/) to the web. ## 🪴 Get Started + Quartz requires **at least [Node](https://nodejs.org/) v16** to function correctly. In your terminal of choice, enter the following commands line by line: ```shell @@ -26,7 +27,8 @@ When you're ready, you can edit `quartz.config.ts` to customize and configure Qu - [[SPA Routing|Ridiculously fast page loads]] and tiny bundle sizes - Fully-customizable parsing, filtering, and page generation through [[making plugins|plugins]] -For a comprehensive list of features, visit the [features page](/features). You can read more the *why* behind these features on the [[philosophy]] page. +For a comprehensive list of features, visit the [features page](/features). You can read more the _why_ behind these features on the [[philosophy]] page. ### 🚧 Troubleshooting + Having trouble with Quartz? Try searching for your issue using the search feature. If you're still having trouble, feel free to [submit an issue](https://github.com/jackyzha0/quartz/issues) if you feel you found a bug or ask for help in our [Discord Community](https://discord.gg/cRFFHYye7t). diff --git a/content/philosophy.md b/content/philosophy.md index f7ff6af1..ecd856b9 100644 --- a/content/philosophy.md +++ b/content/philosophy.md @@ -5,7 +5,7 @@ title: Philosophy of Quartz ## A garden should be a true hypertext > The garden is the web as topology. Every walk through the garden creates new paths, new meanings, and when we add things to the garden we add them in a way that allows many future, unpredicted relationships. -> +> > (The Garden and the Stream) The problem with the file cabinet is that it focuses on efficiency of access and interoperability rather than generativity and creativity. Thinking is not linear, nor is it hierarchical. In fact, not many things are linear or hierarchical at all. Then why is it that most tools and thinking strategies assume a nice chronological or hierarchical order for my thought processes? The ideal tool for thought for me would embrace the messiness of my mind, and organically help insights emerge from chaos instead of forcing an artificial order. A rhizomatic, not arboresecent, form of note taking. @@ -20,7 +20,7 @@ Quartz embraces the inherent rhizomatic and web-like nature of our thinking and The goal of digital gardening should be to tap into your network’s collective intelligence to create constructive feedback loops. If done well, I have a shareable representation of my thoughts that I can send out into the world and people can respond. Even for my most half-baked thoughts, this helps me create a feedback cycle to strengthen and fully flesh out that idea. -Quartz is designed first and foremost as a tool for publishing [digital gardens](https://jzhao.xyz/posts/networked-thought/) to the web. To me, digital gardening is not just passive knowledge collection. It’s a form of expression and sharing. +Quartz is designed first and foremost as a tool for publishing [digital gardens](https://jzhao.xyz/posts/networked-thought/) to the web. To me, digital gardening is not just passive knowledge collection. It’s a form of expression and sharing. > “[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important.” — Richard Hamming diff --git a/content/tags/component.md b/content/tags/component.md index 5b56fbd6..57592e8c 100644 --- a/content/tags/component.md +++ b/content/tags/component.md @@ -2,4 +2,4 @@ title: Components --- -Want to create your own custom component? Check out the advanced guide on [[creating components]] for more information. \ No newline at end of file +Want to create your own custom component? Check out the advanced guide on [[creating components]] for more information. diff --git a/globals.d.ts b/globals.d.ts index 6cc2479c..4473d59e 100644 --- a/globals.d.ts +++ b/globals.d.ts @@ -1,8 +1,10 @@ export declare global { interface Document { - addEventListener(type: K, - listener: (this: Document, ev: CustomEventMap[K]) => void): void; - dispatchEvent(ev: CustomEventMap[K]): void; + addEventListener( + type: K, + listener: (this: Document, ev: CustomEventMap[K]) => void, + ): void + dispatchEvent(ev: CustomEventMap[K]): void } interface Window { spaNavigate(url: URL, isBack: boolean = false) diff --git a/index.d.ts b/index.d.ts index b98a5be4..4a93f164 100644 --- a/index.d.ts +++ b/index.d.ts @@ -1,11 +1,11 @@ -declare module '*.scss' { +declare module "*.scss" { const content: string export = content } // dom custom event interface CustomEventMap { - "nav": CustomEvent<{ url: CanonicalSlug }>; + nav: CustomEvent<{ url: CanonicalSlug }> } declare const fetchData: Promise diff --git a/quartz.config.ts b/quartz.config.ts index cd1e9ef1..d6aed2fc 100644 --- a/quartz.config.ts +++ b/quartz.config.ts @@ -7,7 +7,7 @@ const generalConfiguration: GlobalConfiguration = { enableSPA: true, enablePopovers: true, analytics: { - provider: 'plausible', + provider: "plausible", }, baseUrl: "quartz.jzhao.xyz", ignorePatterns: ["private", "templates"], @@ -19,27 +19,27 @@ const generalConfiguration: GlobalConfiguration = { }, colors: { lightMode: { - light: '#faf8f8', - lightgray: '#e5e5e5', - gray: '#b8b8b8', - darkgray: '#4e4e4e', - dark: '#2b2b2b', - secondary: '#284b63', - tertiary: '#84a59d', - highlight: 'rgba(143, 159, 169, 0.15)', + light: "#faf8f8", + lightgray: "#e5e5e5", + gray: "#b8b8b8", + darkgray: "#4e4e4e", + dark: "#2b2b2b", + secondary: "#284b63", + tertiary: "#84a59d", + highlight: "rgba(143, 159, 169, 0.15)", }, darkMode: { - light: '#161618', - lightgray: '#393639', - gray: '#646464', - darkgray: '#d4d4d4', - dark: '#ebebec', - secondary: '#7b97aa', - tertiary: '#84a59d', - highlight: 'rgba(143, 159, 169, 0.15)', + light: "#161618", + lightgray: "#393639", + gray: "#646464", + darkgray: "#d4d4d4", + dark: "#ebebec", + secondary: "#7b97aa", + tertiary: "#84a59d", + highlight: "rgba(143, 159, 169, 0.15)", }, - } - } + }, + }, } const sharedPageComponents = { @@ -47,18 +47,14 @@ const sharedPageComponents = { header: [], footer: Component.Footer({ links: { - "GitHub": "https://github.com/jackyzha0/quartz", - "Discord Community": "https://discord.gg/cRFFHYye7t" - } - }) + GitHub: "https://github.com/jackyzha0/quartz", + "Discord Community": "https://discord.gg/cRFFHYye7t", + }, + }), } const contentPageLayout: PageLayout = { - beforeBody: [ - Component.ArticleTitle(), - Component.ReadingTime(), - Component.TagList(), - ], + beforeBody: [Component.ArticleTitle(), Component.ReadingTime(), Component.TagList()], left: [ Component.PageTitle(), Component.MobileOnly(Component.Spacer()), @@ -66,21 +62,16 @@ const contentPageLayout: PageLayout = { Component.Darkmode(), Component.DesktopOnly(Component.TableOfContents()), ], - right: [ - Component.Graph(), - Component.Backlinks(), - ], + right: [Component.Graph(), Component.Backlinks()], } const listPageLayout: PageLayout = { - beforeBody: [ - Component.ArticleTitle() - ], + beforeBody: [Component.ArticleTitle()], left: [ Component.PageTitle(), Component.MobileOnly(Component.Spacer()), Component.Search(), - Component.Darkmode() + Component.Darkmode(), ], right: [], } @@ -92,18 +83,16 @@ const config: QuartzConfig = { Plugin.FrontMatter(), Plugin.TableOfContents(), Plugin.CreatedModifiedDate({ - priority: ['frontmatter', 'filesystem'] // you can add 'git' here for last modified from Git but this makes the build slower + priority: ["frontmatter", "filesystem"], // you can add 'git' here for last modified from Git but this makes the build slower }), Plugin.SyntaxHighlighting(), Plugin.ObsidianFlavoredMarkdown(), Plugin.GitHubFlavoredMarkdown(), - Plugin.CrawlLinks({ markdownLinkResolution: 'shortest' }), - Plugin.Latex({ renderEngine: 'katex' }), + Plugin.CrawlLinks({ markdownLinkResolution: "shortest" }), + Plugin.Latex({ renderEngine: "katex" }), Plugin.Description(), ], - filters: [ - Plugin.RemoveDrafts(), - ], + filters: [Plugin.RemoveDrafts()], emitters: [ Plugin.AliasRedirects(), Plugin.ContentPage({ @@ -125,7 +114,7 @@ const config: QuartzConfig = { enableSiteMap: true, enableRSS: true, }), - ] + ], }, } diff --git a/quartz/bootstrap-cli.mjs b/quartz/bootstrap-cli.mjs index b4bf3a95..f25484be 100755 --- a/quartz/bootstrap-cli.mjs +++ b/quartz/bootstrap-cli.mjs @@ -1,19 +1,19 @@ #!/usr/bin/env node -import { promises, readFileSync } from 'fs' -import yargs from 'yargs' -import path from 'path' -import { hideBin } from 'yargs/helpers' -import esbuild from 'esbuild' -import chalk from 'chalk' -import { sassPlugin } from 'esbuild-sass-plugin' -import fs from 'fs' -import { intro, isCancel, outro, select, text } from '@clack/prompts' -import { rimraf } from 'rimraf' -import prettyBytes from 'pretty-bytes' -import { spawnSync } from 'child_process' +import { promises, readFileSync } from "fs" +import yargs from "yargs" +import path from "path" +import { hideBin } from "yargs/helpers" +import esbuild from "esbuild" +import chalk from "chalk" +import { sassPlugin } from "esbuild-sass-plugin" +import fs from "fs" +import { intro, isCancel, outro, select, text } from "@clack/prompts" +import { rimraf } from "rimraf" +import prettyBytes from "pretty-bytes" +import { spawnSync } from "child_process" -const UPSTREAM_NAME = 'upstream' -const QUARTZ_SOURCE_BRANCH = 'v4-alpha' +const UPSTREAM_NAME = "upstream" +const QUARTZ_SOURCE_BRANCH = "v4-alpha" const cwd = process.cwd() const cacheDir = path.join(cwd, ".quartz-cache") const cacheFile = "./.quartz-cache/transpiled-build.mjs" @@ -24,16 +24,16 @@ const contentCacheFolder = path.join(cacheDir, "content-cache") const CommonArgv = { directory: { string: true, - alias: ['d'], - default: 'content', - describe: 'directory to look for content files' + alias: ["d"], + default: "content", + describe: "directory to look for content files", }, verbose: { boolean: true, - alias: ['v'], + alias: ["v"], default: false, - describe: 'print out extra logging information' - } + describe: "print out extra logging information", + }, } const SyncArgv = { @@ -41,47 +41,46 @@ const SyncArgv = { commit: { boolean: true, default: true, - describe: 'create a git commit for your unsaved changes' + describe: "create a git commit for your unsaved changes", }, push: { boolean: true, default: true, - describe: 'push updates to your Quartz fork' + describe: "push updates to your Quartz fork", }, force: { boolean: true, - alias: ['f'], + alias: ["f"], default: true, - describe: 'whether to apply the --force flag to git commands' + describe: "whether to apply the --force flag to git commands", }, pull: { boolean: true, default: true, - describe: 'pull updates from your Quartz fork' - } + describe: "pull updates from your Quartz fork", + }, } const BuildArgv = { ...CommonArgv, output: { string: true, - alias: ['o'], - default: 'public', - describe: 'output folder for files' + alias: ["o"], + default: "public", + describe: "output folder for files", }, serve: { boolean: true, default: false, - describe: 'run a local server to live-preview your Quartz' + describe: "run a local server to live-preview your Quartz", }, port: { number: true, default: 8080, - describe: 'port to serve Quartz on' + describe: "port to serve Quartz on", }, } - function escapePath(fp) { return fp .replace(/\\ /g, " ") // unescape spaces @@ -91,7 +90,6 @@ function escapePath(fp) { } function exitIfCancel(val) { - if (isCancel(val)) { outro(chalk.red("Exiting")) process.exit(0) @@ -101,32 +99,48 @@ function exitIfCancel(val) { } async function stashContentFolder(contentFolder) { - await fs.promises.cp(contentFolder, contentCacheFolder, { force: true, recursive: true, verbatimSymlinks: true, preserveTimestamps: true }) + await fs.promises.cp(contentFolder, contentCacheFolder, { + force: true, + recursive: true, + verbatimSymlinks: true, + preserveTimestamps: true, + }) await fs.promises.rm(contentFolder, { force: true, recursive: true }) } async function popContentFolder(contentFolder) { - await fs.promises.cp(contentCacheFolder, contentFolder, { force: true, recursive: true, verbatimSymlinks: true, preserveTimestamps: true }) + await fs.promises.cp(contentCacheFolder, contentFolder, { + force: true, + recursive: true, + verbatimSymlinks: true, + preserveTimestamps: true, + }) await fs.promises.rm(contentCacheFolder, { force: true, recursive: true }) } yargs(hideBin(process.argv)) .scriptName("quartz") .version(version) - .usage('$0 [args]') - .command('create', 'Initialize Quartz', CommonArgv, async argv => { + .usage("$0 [args]") + .command("create", "Initialize Quartz", CommonArgv, async (argv) => { console.log() intro(chalk.bgGreen.black(` Quartz v${version} `)) const contentFolder = path.join(cwd, argv.directory) - const setupStrategy = exitIfCancel(await select({ - message: `Choose how to initialize the content in \`${contentFolder}\``, - options: [ - { value: 'new', label: "Empty Quartz" }, - { value: 'copy', label: "Replace with an existing folder", hint: "overwrites `content`" }, - { value: 'symlink', label: "Symlink an existing folder", hint: "don't select this unless you know what you are doing!" }, - { value: 'keep', label: "Keep the existing files" }, - ] - })) + const setupStrategy = exitIfCancel( + await select({ + message: `Choose how to initialize the content in \`${contentFolder}\``, + options: [ + { value: "new", label: "Empty Quartz" }, + { value: "copy", label: "Replace with an existing folder", hint: "overwrites `content`" }, + { + value: "symlink", + label: "Symlink an existing folder", + hint: "don't select this unless you know what you are doing!", + }, + { value: "keep", label: "Keep the existing files" }, + ], + }), + ) async function rmContentFolder() { const contentStat = await fs.promises.lstat(contentFolder) @@ -139,54 +153,77 @@ yargs(hideBin(process.argv)) } } - if (setupStrategy === 'copy' || setupStrategy === 'symlink') { - const originalFolder = escapePath(exitIfCancel(await text({ - message: "Enter the full path to existing content folder", - placeholder: 'On most terminal emulators, you can drag and drop a folder into the window and it will paste the full path', - validate(fp) { - const fullPath = escapePath(fp) - if (!fs.existsSync(fullPath)) { - return "The given path doesn't exist" - } else if (!fs.lstatSync(fullPath).isDirectory()) { - return "The given path is not a folder" - } - } - }))) + if (setupStrategy === "copy" || setupStrategy === "symlink") { + const originalFolder = escapePath( + exitIfCancel( + await text({ + message: "Enter the full path to existing content folder", + placeholder: + "On most terminal emulators, you can drag and drop a folder into the window and it will paste the full path", + validate(fp) { + const fullPath = escapePath(fp) + if (!fs.existsSync(fullPath)) { + return "The given path doesn't exist" + } else if (!fs.lstatSync(fullPath).isDirectory()) { + return "The given path is not a folder" + } + }, + }), + ), + ) await rmContentFolder() - if (setupStrategy === 'copy') { + if (setupStrategy === "copy") { await fs.promises.cp(originalFolder, contentFolder, { recursive: true }) - } else if (setupStrategy === 'symlink') { - await fs.promises.symlink(originalFolder, contentFolder, 'dir') + } else if (setupStrategy === "symlink") { + await fs.promises.symlink(originalFolder, contentFolder, "dir") } - } else if (setupStrategy === 'new') { + } else if (setupStrategy === "new") { await rmContentFolder() await fs.promises.mkdir(contentFolder) - await fs.promises.writeFile(path.join(contentFolder, "index.md"), + await fs.promises.writeFile( + path.join(contentFolder, "index.md"), `--- title: Welcome to Quartz --- This is a blank Quartz installation. See the [documentation](https://quartz.jzhao.xyz) for how to get started. -` +`, ) } - + // get a prefered link resolution strategy - const linkResolutionStrategy = exitIfCancel(await select({ - message: `Choose how Quartz should resolve links in your content. You can change this later in \`quartz.config.ts\`.`, - options: [ - { value: 'absolute', label: "Treat links as absolute path", hint: "for content made for Quartz 3 and Hugo" }, - { value: 'shortest', label: "Treat links as shortest path", hint: "for most Obsidian vaults" }, - { value: 'relative', label: "Treat links as relative paths", hint: "for just normal Markdown files" }, - ] - })) + const linkResolutionStrategy = exitIfCancel( + await select({ + message: `Choose how Quartz should resolve links in your content. You can change this later in \`quartz.config.ts\`.`, + options: [ + { + value: "absolute", + label: "Treat links as absolute path", + hint: "for content made for Quartz 3 and Hugo", + }, + { + value: "shortest", + label: "Treat links as shortest path", + hint: "for most Obsidian vaults", + }, + { + value: "relative", + label: "Treat links as relative paths", + hint: "for just normal Markdown files", + }, + ], + }), + ) // now, do config changes const configFilePath = path.join(cwd, "quartz.config.ts") - let configContent = await fs.promises.readFile(configFilePath, { encoding: 'utf-8' }) - configContent = configContent.replace(/markdownLinkResolution: '(.+)'/, `markdownLinkResolution: '${linkResolutionStrategy}'`) + let configContent = await fs.promises.readFile(configFilePath, { encoding: "utf-8" }) + configContent = configContent.replace( + /markdownLinkResolution: '(.+)'/, + `markdownLinkResolution: '${linkResolutionStrategy}'`, + ) await fs.promises.writeFile(configFilePath, configContent) outro(`You're all set! Not sure what to do next? Try: @@ -195,105 +232,120 @@ See the [documentation](https://quartz.jzhao.xyz) for how to get started. • Hosting your Quartz online (see: https://quartz.jzhao.xyz/setup/hosting) `) }) - .command('update', 'Get the latest Quartz updates', CommonArgv, async argv => { + .command("update", "Get the latest Quartz updates", CommonArgv, async (argv) => { const contentFolder = path.join(cwd, argv.directory) console.log(chalk.bgGreen.black(`\n Quartz v${version} \n`)) - console.log('Backing up your content') + console.log("Backing up your content") await stashContentFolder(contentFolder) - console.log("Pulling updates... you may need to resolve some `git` conflicts if you've made changes to components or plugins.") - spawnSync('git', ['pull', UPSTREAM_NAME, QUARTZ_SOURCE_BRANCH], { stdio: 'inherit' }) + console.log( + "Pulling updates... you may need to resolve some `git` conflicts if you've made changes to components or plugins.", + ) + spawnSync("git", ["pull", UPSTREAM_NAME, QUARTZ_SOURCE_BRANCH], { stdio: "inherit" }) await popContentFolder(contentFolder) - console.log(chalk.green('Done!')) + console.log(chalk.green("Done!")) }) - .command('sync', 'Sync your Quartz to and from GitHub.', SyncArgv, async argv => { + .command("sync", "Sync your Quartz to and from GitHub.", SyncArgv, async (argv) => { const contentFolder = path.join(cwd, argv.directory) console.log(chalk.bgGreen.black(`\n Quartz v${version} \n`)) - console.log('Backing up your content') + console.log("Backing up your content") if (argv.commit) { - const currentTimestamp = new Date().toLocaleString('en-US', { dateStyle: "medium", timeStyle: "short" }) - spawnSync('git', ['commit', '-am', `Quartz sync: ${currentTimestamp}`], { stdio: 'inherit' }) + const currentTimestamp = new Date().toLocaleString("en-US", { + dateStyle: "medium", + timeStyle: "short", + }) + spawnSync("git", ["commit", "-am", `Quartz sync: ${currentTimestamp}`], { stdio: "inherit" }) } await stashContentFolder(contentFolder) if (argv.pull) { - console.log("Pulling updates from your repository. You may need to resolve some `git` conflicts if you've made changes to components or plugins.") - spawnSync('git', ['pull', 'origin', QUARTZ_SOURCE_BRANCH], { stdio: 'inherit' }) + console.log( + "Pulling updates from your repository. You may need to resolve some `git` conflicts if you've made changes to components or plugins.", + ) + spawnSync("git", ["pull", "origin", QUARTZ_SOURCE_BRANCH], { stdio: "inherit" }) } await popContentFolder(contentFolder) if (argv.push) { console.log("Pushing your changes") - const args = argv.force ? - ['push', '-f', 'origin', QUARTZ_SOURCE_BRANCH] : - ['push', 'origin', QUARTZ_SOURCE_BRANCH] - spawnSync('git', args, { stdio: 'inherit' }) + const args = argv.force + ? ["push", "-f", "origin", QUARTZ_SOURCE_BRANCH] + : ["push", "origin", QUARTZ_SOURCE_BRANCH] + spawnSync("git", args, { stdio: "inherit" }) } - console.log(chalk.green('Done!')) + console.log(chalk.green("Done!")) }) - .command('build', 'Build Quartz into a bundle of static HTML files', BuildArgv, async argv => { - const result = await esbuild.build({ - entryPoints: [fp], - outfile: path.join("quartz", cacheFile), - bundle: true, - keepNames: true, - platform: "node", - format: "esm", - jsx: "automatic", - jsxImportSource: "preact", - packages: "external", - metafile: true, - sourcemap: true, - plugins: [ - sassPlugin({ - type: 'css-text', - }), - { - name: 'inline-script-loader', - setup(build) { - build.onLoad({ filter: /\.inline\.(ts|js)$/ }, async (args) => { - let text = await promises.readFile(args.path, 'utf8') + .command("build", "Build Quartz into a bundle of static HTML files", BuildArgv, async (argv) => { + const result = await esbuild + .build({ + entryPoints: [fp], + outfile: path.join("quartz", cacheFile), + bundle: true, + keepNames: true, + platform: "node", + format: "esm", + jsx: "automatic", + jsxImportSource: "preact", + packages: "external", + metafile: true, + sourcemap: true, + plugins: [ + sassPlugin({ + type: "css-text", + }), + { + name: "inline-script-loader", + setup(build) { + build.onLoad({ filter: /\.inline\.(ts|js)$/ }, async (args) => { + let text = await promises.readFile(args.path, "utf8") - // remove default exports that we manually inserted - text = text.replace('export default', '') - text = text.replace('export', '') + // remove default exports that we manually inserted + text = text.replace("export default", "") + text = text.replace("export", "") - const sourcefile = path.relative(path.resolve('.'), args.path) - const resolveDir = path.dirname(sourcefile) - const transpiled = await esbuild.build({ - stdin: { - contents: text, - loader: 'ts', - resolveDir, - sourcefile, - }, - write: false, - bundle: true, - platform: "browser", - format: "esm", + const sourcefile = path.relative(path.resolve("."), args.path) + const resolveDir = path.dirname(sourcefile) + const transpiled = await esbuild.build({ + stdin: { + contents: text, + loader: "ts", + resolveDir, + sourcefile, + }, + write: false, + bundle: true, + platform: "browser", + format: "esm", + }) + const rawMod = transpiled.outputFiles[0].text + return { + contents: rawMod, + loader: "text", + } }) - const rawMod = transpiled.outputFiles[0].text - return { - contents: rawMod, - loader: 'text', - } - }) - } - } - ] - }).catch(err => { - console.error(`${chalk.red("Couldn't parse Quartz configuration:")} ${fp}`) - console.log(`Reason: ${chalk.grey(err)}`) - console.log("hint: make sure all the required dependencies are installed (run `npm install`)") - process.exit(1) - }) + }, + }, + ], + }) + .catch((err) => { + console.error(`${chalk.red("Couldn't parse Quartz configuration:")} ${fp}`) + console.log(`Reason: ${chalk.grey(err)}`) + console.log( + "hint: make sure all the required dependencies are installed (run `npm install`)", + ) + process.exit(1) + }) if (argv.verbose) { - const outputFileName = 'quartz/.quartz-cache/transpiled-build.mjs' + const outputFileName = "quartz/.quartz-cache/transpiled-build.mjs" const meta = result.metafile.outputs[outputFileName] - console.log(`Successfully transpiled ${Object.keys(meta.inputs).length} files (${prettyBytes(meta.bytes)})`) + console.log( + `Successfully transpiled ${Object.keys(meta.inputs).length} files (${prettyBytes( + meta.bytes, + )})`, + ) } const { default: buildQuartz } = await import(cacheFile) @@ -302,5 +354,4 @@ See the [documentation](https://quartz.jzhao.xyz) for how to get started. .showHelpOnFail(false) .help() .strict() - .demandCommand() - .argv + .demandCommand().argv diff --git a/quartz/bootstrap-worker.mjs b/quartz/bootstrap-worker.mjs index 7db24c06..b08689c3 100644 --- a/quartz/bootstrap-worker.mjs +++ b/quartz/bootstrap-worker.mjs @@ -1,7 +1,7 @@ #!/usr/bin/env node -import workerpool from 'workerpool' +import workerpool from "workerpool" const cacheFile = "./.quartz-cache/transpiled-worker.mjs" const { parseFiles } = await import(cacheFile) workerpool.worker({ - parseFiles + parseFiles, }) diff --git a/quartz/build.ts b/quartz/build.ts index 2ab76548..df83f6e7 100644 --- a/quartz/build.ts +++ b/quartz/build.ts @@ -1,4 +1,4 @@ -import 'source-map-support/register.js' +import "source-map-support/register.js" import path from "path" import { PerfTimer } from "./perf" import { rimraf } from "rimraf" @@ -12,8 +12,8 @@ import { emitContent } from "./processors/emit" import cfg from "../quartz.config" import { FilePath } from "./path" import chokidar from "chokidar" -import { ProcessedContent } from './plugins/vfile' -import WebSocket, { WebSocketServer } from 'ws' +import { ProcessedContent } from "./plugins/vfile" +import WebSocket, { WebSocketServer } from "ws" interface Argv { directory: string @@ -29,30 +29,38 @@ export default async function buildQuartz(argv: Argv, version: string) { const output = argv.output const pluginCount = Object.values(cfg.plugins).flat().length - const pluginNames = (key: 'transformers' | 'filters' | 'emitters') => cfg.plugins[key].map(plugin => plugin.name) + const pluginNames = (key: "transformers" | "filters" | "emitters") => + cfg.plugins[key].map((plugin) => plugin.name) if (argv.verbose) { console.log(`Loaded ${pluginCount} plugins`) - console.log(` Transformers: ${pluginNames('transformers').join(", ")}`) - console.log(` Filters: ${pluginNames('filters').join(", ")}`) - console.log(` Emitters: ${pluginNames('emitters').join(", ")}`) + console.log(` Transformers: ${pluginNames("transformers").join(", ")}`) + console.log(` Filters: ${pluginNames("filters").join(", ")}`) + console.log(` Emitters: ${pluginNames("emitters").join(", ")}`) } // clean - perf.addEvent('clean') + perf.addEvent("clean") await rimraf(output) - console.log(`Cleaned output directory \`${output}\` in ${perf.timeSince('clean')}`) + console.log(`Cleaned output directory \`${output}\` in ${perf.timeSince("clean")}`) // glob - perf.addEvent('glob') - const fps = await globby('**/*.md', { + perf.addEvent("glob") + const fps = await globby("**/*.md", { cwd: argv.directory, ignore: cfg.configuration.ignorePatterns, gitignore: true, }) - console.log(`Found ${fps.length} input files from \`${argv.directory}\` in ${perf.timeSince('glob')}`) + console.log( + `Found ${fps.length} input files from \`${argv.directory}\` in ${perf.timeSince("glob")}`, + ) - const filePaths = fps.map(fp => `${argv.directory}${path.sep}${fp}` as FilePath) - const parsedFiles = await parseMarkdown(cfg.plugins.transformers, argv.directory, filePaths, argv.verbose) + const filePaths = fps.map((fp) => `${argv.directory}${path.sep}${fp}` as FilePath) + const parsedFiles = await parseMarkdown( + cfg.plugins.transformers, + argv.directory, + filePaths, + argv.verbose, + ) const filteredContent = filterContent(cfg.plugins.filters, parsedFiles, argv.verbose) await emitContent(argv.directory, output, cfg, filteredContent, argv.serve, argv.verbose) console.log(chalk.green(`Done processing ${fps.length} files in ${perf.timeSince()}`)) @@ -60,7 +68,7 @@ export default async function buildQuartz(argv: Argv, version: string) { if (argv.serve) { const wss = new WebSocketServer({ port: 3001 }) const connections: WebSocket[] = [] - wss.on('connection', ws => connections.push(ws)) + wss.on("connection", (ws) => connections.push(ws)) const ignored = await isGitIgnored() const contentMap = new Map() @@ -69,15 +77,20 @@ export default async function buildQuartz(argv: Argv, version: string) { contentMap.set(vfile.data.filePath!, content) } - async function rebuild(fp: string, action: 'add' | 'change' | 'unlink') { - perf.addEvent('rebuild') + async function rebuild(fp: string, action: "add" | "change" | "unlink") { + perf.addEvent("rebuild") if (!ignored(fp)) { console.log(chalk.yellow(`Detected change in ${fp}, rebuilding...`)) const fullPath = `${argv.directory}${path.sep}${fp}` as FilePath - if (action === 'add' || action === 'change') { - const [parsedContent] = await parseMarkdown(cfg.plugins.transformers, argv.directory, [fullPath], argv.verbose) + if (action === "add" || action === "change") { + const [parsedContent] = await parseMarkdown( + cfg.plugins.transformers, + argv.directory, + [fullPath], + argv.verbose, + ) contentMap.set(fullPath, parsedContent) - } else if (action === 'unlink') { + } else if (action === "unlink") { contentMap.delete(fullPath) } @@ -85,21 +98,21 @@ export default async function buildQuartz(argv: Argv, version: string) { const parsedFiles = [...contentMap.values()] const filteredContent = filterContent(cfg.plugins.filters, parsedFiles, argv.verbose) await emitContent(argv.directory, output, cfg, filteredContent, argv.serve, argv.verbose) - console.log(chalk.green(`Done rebuilding in ${perf.timeSince('rebuild')}`)) - connections.forEach(conn => conn.send('rebuild')) + console.log(chalk.green(`Done rebuilding in ${perf.timeSince("rebuild")}`)) + connections.forEach((conn) => conn.send("rebuild")) } } - const watcher = chokidar.watch('.', { + const watcher = chokidar.watch(".", { persistent: true, cwd: argv.directory, ignoreInitial: true, }) watcher - .on('add', fp => rebuild(fp, 'add')) - .on('change', fp => rebuild(fp, 'change')) - .on('unlink', fp => rebuild(fp, 'unlink')) + .on("add", (fp) => rebuild(fp, "add")) + .on("change", (fp) => rebuild(fp, "change")) + .on("unlink", (fp) => rebuild(fp, "unlink")) const server = http.createServer(async (req, res) => { await serveHandler(req, res, { @@ -107,15 +120,16 @@ export default async function buildQuartz(argv: Argv, version: string) { directoryListing: false, }) const status = res.statusCode - const statusString = (status >= 200 && status < 300) ? - chalk.green(`[${status}]`) : - (status >= 300 && status < 400) ? - chalk.yellow(`[${status}]`) : - chalk.red(`[${status}]`) + const statusString = + status >= 200 && status < 300 + ? chalk.green(`[${status}]`) + : status >= 300 && status < 400 + ? chalk.yellow(`[${status}]`) + : chalk.red(`[${status}]`) console.log(statusString + chalk.grey(` ${req.url}`)) }) server.listen(argv.port) console.log(chalk.cyan(`Started a Quartz server listening at http://localhost:${argv.port}`)) - console.log('hint: exit with ctrl+c') + console.log("hint: exit with ctrl+c") } } diff --git a/quartz/cfg.ts b/quartz/cfg.ts index 420ffe93..d8a14a32 100644 --- a/quartz/cfg.ts +++ b/quartz/cfg.ts @@ -5,43 +5,43 @@ import { Theme } from "./theme" export type Analytics = | null | { - provider: 'plausible' - } + provider: "plausible" + } | { - provider: 'google', - tagId: string - } + provider: "google" + tagId: string + } export interface GlobalConfiguration { - pageTitle: string, + pageTitle: string /** Whether to enable single-page-app style rendering. this prevents flashes of unstyled content and improves smoothness of Quartz */ - enableSPA: boolean, + enableSPA: boolean /** Whether to display Wikipedia-style popovers when hovering over links */ - enablePopovers: boolean, + enablePopovers: boolean /** Analytics mode */ analytics: Analytics /** Glob patterns to not search */ - ignorePatterns: string[], + ignorePatterns: string[] /** Base URL to use for CNAME files, sitemaps, and RSS feeds that require an absolute URL. - * Quartz will avoid using this as much as possible and use relative URLs most of the time - */ - baseUrl?: string, + * Quartz will avoid using this as much as possible and use relative URLs most of the time + */ + baseUrl?: string theme: Theme } export interface QuartzConfig { - configuration: GlobalConfiguration, - plugins: PluginTypes, + configuration: GlobalConfiguration + plugins: PluginTypes } export interface FullPageLayout { head: QuartzComponent - header: QuartzComponent[], - beforeBody: QuartzComponent[], - pageBody: QuartzComponent, - left: QuartzComponent[], - right: QuartzComponent[], - footer: QuartzComponent, + header: QuartzComponent[] + beforeBody: QuartzComponent[] + pageBody: QuartzComponent + left: QuartzComponent[] + right: QuartzComponent[] + footer: QuartzComponent } export type PageLayout = Pick diff --git a/quartz/components/Backlinks.tsx b/quartz/components/Backlinks.tsx index 93313878..575e6133 100644 --- a/quartz/components/Backlinks.tsx +++ b/quartz/components/Backlinks.tsx @@ -4,15 +4,25 @@ import { canonicalizeServer, resolveRelative } from "../path" function Backlinks({ fileData, allFiles }: QuartzComponentProps) { const slug = canonicalizeServer(fileData.slug!) - const backlinkFiles = allFiles.filter(file => file.links?.includes(slug)) - return
-

Backlinks

- -
+ const backlinkFiles = allFiles.filter((file) => file.links?.includes(slug)) + return ( +
+

Backlinks

+ +
+ ) } Backlinks.css = style diff --git a/quartz/components/Body.tsx b/quartz/components/Body.tsx index 6b1f234d..fbb85729 100644 --- a/quartz/components/Body.tsx +++ b/quartz/components/Body.tsx @@ -1,16 +1,13 @@ // @ts-ignore -import clipboardScript from './scripts/clipboard.inline' -import clipboardStyle from './styles/clipboard.scss' +import clipboardScript from "./scripts/clipboard.inline" +import clipboardStyle from "./styles/clipboard.scss" import { QuartzComponentConstructor, QuartzComponentProps } from "./types" function Body({ children }: QuartzComponentProps) { - return
- {children} -
+ return
{children}
} Body.afterDOMLoaded = clipboardScript Body.css = clipboardStyle export default (() => Body) satisfies QuartzComponentConstructor - diff --git a/quartz/components/Darkmode.tsx b/quartz/components/Darkmode.tsx index 49f61c7d..afbf2bd9 100644 --- a/quartz/components/Darkmode.tsx +++ b/quartz/components/Darkmode.tsx @@ -1,50 +1,48 @@ -// @ts-ignore: this is safe, we don't want to actually make darkmode.inline.ts a module as +// @ts-ignore: this is safe, we don't want to actually make darkmode.inline.ts a module as // modules are automatically deferred and we don't want that to happen for critical beforeDOMLoads // see: https://v8.dev/features/modules#defer import darkmodeScript from "./scripts/darkmode.inline" -import styles from './styles/darkmode.scss' +import styles from "./styles/darkmode.scss" import { QuartzComponentConstructor } from "./types" function Darkmode() { - return
- - - -
+ return ( +
+ + + +
+ ) } Darkmode.beforeDOMLoaded = darkmodeScript diff --git a/quartz/components/Date.tsx b/quartz/components/Date.tsx index 7ea6ad4d..16c45440 100644 --- a/quartz/components/Date.tsx +++ b/quartz/components/Date.tsx @@ -3,10 +3,10 @@ interface Props { } export function Date({ date }: Props) { - const formattedDate = date.toLocaleDateString('en-US', { + const formattedDate = date.toLocaleDateString("en-US", { year: "numeric", month: "short", - day: '2-digit' + day: "2-digit", }) return <>{formattedDate} } diff --git a/quartz/components/Footer.tsx b/quartz/components/Footer.tsx index 1ea2ef11..f33617e4 100644 --- a/quartz/components/Footer.tsx +++ b/quartz/components/Footer.tsx @@ -1,6 +1,6 @@ import { QuartzComponentConstructor } from "./types" import style from "./styles/footer.scss" -import {version} from "../../package.json" +import { version } from "../../package.json" interface Options { links: Record @@ -10,13 +10,21 @@ export default ((opts?: Options) => { function Footer() { const year = new Date().getFullYear() const links = opts?.links ?? [] - return + return ( +
+
+

+ Created with Quartz v{version}, © {year} +

+
    + {Object.entries(links).map(([text, link]) => ( +
  • + {text} +
    • + ))} +
+
+ ) } Footer.css = style diff --git a/quartz/components/Graph.tsx b/quartz/components/Graph.tsx index 1757991b..d8ec6e55 100644 --- a/quartz/components/Graph.tsx +++ b/quartz/components/Graph.tsx @@ -4,19 +4,19 @@ import script from "./scripts/graph.inline" import style from "./styles/graph.scss" export interface D3Config { - drag: boolean, - zoom: boolean, - depth: number, - scale: number, - repelForce: number, - centerForce: number, - linkDistance: number, - fontSize: number, + drag: boolean + zoom: boolean + depth: number + scale: number + repelForce: number + centerForce: number + linkDistance: number + fontSize: number opacityScale: number } interface GraphOptions { - localGraph: Partial | undefined, + localGraph: Partial | undefined globalGraph: Partial | undefined } @@ -30,7 +30,7 @@ const defaultOptions: GraphOptions = { centerForce: 0.3, linkDistance: 30, fontSize: 0.6, - opacityScale: 1 + opacityScale: 1, }, globalGraph: { drag: true, @@ -41,21 +41,32 @@ const defaultOptions: GraphOptions = { centerForce: 0.3, linkDistance: 30, fontSize: 0.6, - opacityScale: 1 - } + opacityScale: 1, + }, } export default ((opts?: GraphOptions) => { function Graph() { const localGraph = { ...opts?.localGraph, ...defaultOptions.localGraph } const globalGraph = { ...opts?.globalGraph, ...defaultOptions.globalGraph } - return
-

Graph View

-
-
- - +

Graph View

+
+
+ + - + s-2-0.897-2-2s0.897-2,2-2S47,39.897,47,41z M49,10c-2.206,0-4-1.794-4-4s1.794-4,4-4s4,1.794,4,4S51.206,10,49,10z" + /> + +
+
+
+
-
-
-
-
+ ) } Graph.css = style diff --git a/quartz/components/Head.tsx b/quartz/components/Head.tsx index b3700544..f57e0e2d 100644 --- a/quartz/components/Head.tsx +++ b/quartz/components/Head.tsx @@ -12,23 +12,29 @@ export default (() => { const iconPath = baseDir + "/static/icon.png" const ogImagePath = baseDir + "/static/og-image.png" - return - {title} - - - - - - - - - - - - - {css.map(href => )} - {js.filter(resource => resource.loadTime === "beforeDOMReady").map(res => JSResourceToScriptElement(res, true))} - + return ( + + {title} + + + + + + + + + + + + + {css.map((href) => ( + + ))} + {js + .filter((resource) => resource.loadTime === "beforeDOMReady") + .map((res) => JSResourceToScriptElement(res, true))} + + ) } return Head diff --git a/quartz/components/Header.tsx b/quartz/components/Header.tsx index 0f13ca26..3fd8eca9 100644 --- a/quartz/components/Header.tsx +++ b/quartz/components/Header.tsx @@ -1,9 +1,7 @@ import { QuartzComponentConstructor, QuartzComponentProps } from "./types" function Header({ children }: QuartzComponentProps) { - return (children.length > 0) ?
- {children} -
: null + return children.length > 0 ?
{children}
: null } Header.css = ` diff --git a/quartz/components/PageList.tsx b/quartz/components/PageList.tsx index da1bf9ff..2f08f629 100644 --- a/quartz/components/PageList.tsx +++ b/quartz/components/PageList.tsx @@ -17,32 +17,51 @@ function byDateAndAlphabetical(f1: QuartzPluginData, f2: QuartzPluginData): numb // otherwise, sort lexographically by title const f1Title = f1.frontmatter?.title.toLowerCase() ?? "" const f2Title = f2.frontmatter?.title.toLowerCase() ?? "" - return f1Title.localeCompare(f2Title) + return f1Title.localeCompare(f2Title) } export function PageList({ fileData, allFiles }: QuartzComponentProps) { const slug = canonicalizeServer(fileData.slug!) - return
    - {allFiles.sort(byDateAndAlphabetical).map(page => { - const title = page.frontmatter?.title - const pageSlug = canonicalizeServer(page.slug!) - const tags = page.frontmatter?.tags ?? [] + return ( +
      + {allFiles.sort(byDateAndAlphabetical).map((page) => { + const title = page.frontmatter?.title + const pageSlug = canonicalizeServer(page.slug!) + const tags = page.frontmatter?.tags ?? [] - return
    • -
      - {page.dates &&

      - -

      } -
      -

      {title}

      -
      -
        - {tags.map(tag =>
      • #{tag}
        • )} -
      -
      -
      • - })} -
    + return ( +
  • +
    + {page.dates && ( +

    + +

    + )} +
    +

    + + {title} + +

    +
    + +
    +
    • + ) + })} +
+ ) } PageList.css = ` diff --git a/quartz/components/PageTitle.tsx b/quartz/components/PageTitle.tsx index 00b23000..f6319ef9 100644 --- a/quartz/components/PageTitle.tsx +++ b/quartz/components/PageTitle.tsx @@ -5,7 +5,11 @@ function PageTitle({ fileData, cfg }: QuartzComponentProps) { const title = cfg?.pageTitle ?? "Untitled Quartz" const slug = canonicalizeServer(fileData.slug!) const baseDir = pathToRoot(slug) - return

{title}

+ return ( +

+ {title} +

+ ) } PageTitle.css = ` diff --git a/quartz/components/ReadingTime.tsx b/quartz/components/ReadingTime.tsx index 3e3d4d74..f802c876 100644 --- a/quartz/components/ReadingTime.tsx +++ b/quartz/components/ReadingTime.tsx @@ -5,7 +5,11 @@ function ReadingTime({ fileData }: QuartzComponentProps) { const text = fileData.text if (text) { const { text: timeTaken, words } = readingTime(text) - return

{words} words, {timeTaken}

+ return ( +

+ {words} words, {timeTaken} +

+ ) } else { return null } diff --git a/quartz/components/Search.tsx b/quartz/components/Search.tsx index f8dd8045..bd9aa694 100644 --- a/quartz/components/Search.tsx +++ b/quartz/components/Search.tsx @@ -5,27 +5,41 @@ import script from "./scripts/search.inline" export default (() => { function Search() { - return
-
-

Search

-
- - Search - Search - - - - - -
-
-
- -
+ return ( +
+
+

Search

+
+ + Search + Search + + + + + +
+
+
+ +
-
+ ) } Search.afterDOMLoaded = script diff --git a/quartz/components/TableOfContents.tsx b/quartz/components/TableOfContents.tsx index ddd5195a..67f29d58 100644 --- a/quartz/components/TableOfContents.tsx +++ b/quartz/components/TableOfContents.tsx @@ -6,11 +6,11 @@ import modernStyle from "./styles/toc.scss" import script from "./scripts/toc.inline" interface Options { - layout: 'modern' | 'legacy' + layout: "modern" | "legacy" } const defaultOptions: Options = { - layout: 'modern' + layout: "modern", } function TableOfContents({ fileData }: QuartzComponentProps) { @@ -18,21 +18,38 @@ function TableOfContents({ fileData }: QuartzComponentProps) { return null } - return
- -
- + return ( +
+ +
+ +
-
+ ) } TableOfContents.css = modernStyle TableOfContents.afterDOMLoaded = script @@ -42,16 +59,22 @@ function LegacyTableOfContents({ fileData }: QuartzComponentProps) { return null } - return
- -

Table of Contents

- - -
+ return ( +
+ +

Table of Contents

+ + +
+ ) } LegacyTableOfContents.css = legacyStyle diff --git a/quartz/components/TagList.tsx b/quartz/components/TagList.tsx index 54147dbe..c36b0a28 100644 --- a/quartz/components/TagList.tsx +++ b/quartz/components/TagList.tsx @@ -1,19 +1,27 @@ import { canonicalizeServer, pathToRoot } from "../path" import { QuartzComponentConstructor, QuartzComponentProps } from "./types" -import { slug as slugAnchor } from 'github-slugger' +import { slug as slugAnchor } from "github-slugger" function TagList({ fileData }: QuartzComponentProps) { const tags = fileData.frontmatter?.tags const slug = canonicalizeServer(fileData.slug!) const baseDir = pathToRoot(slug) if (tags && tags.length > 0) { - return
    {tags.map(tag => { - const display = `#${tag}` - const linkDest = baseDir + `/tags/${slugAnchor(tag)}` - return
  • - {display} -
    • - })}
+ return ( +
    + {tags.map((tag) => { + const display = `#${tag}` + const linkDest = baseDir + `/tags/${slugAnchor(tag)}` + return ( +
  • + + {display} + +
    • + ) + })} +
+ ) } else { return null } diff --git a/quartz/components/index.ts b/quartz/components/index.ts index 35d5a64b..c0fe1ec1 100644 --- a/quartz/components/index.ts +++ b/quartz/components/index.ts @@ -9,7 +9,7 @@ import ReadingTime from "./ReadingTime" import Spacer from "./Spacer" import TableOfContents from "./TableOfContents" import TagList from "./TagList" -import Graph from "./Graph" +import Graph from "./Graph" import Backlinks from "./Backlinks" import Search from "./Search" import Footer from "./Footer" @@ -33,5 +33,5 @@ export { Search, Footer, DesktopOnly, - MobileOnly -} + MobileOnly, +} diff --git a/quartz/components/pages/Content.tsx b/quartz/components/pages/Content.tsx index d233845a..7490a7ea 100644 --- a/quartz/components/pages/Content.tsx +++ b/quartz/components/pages/Content.tsx @@ -1,10 +1,10 @@ import { QuartzComponentConstructor, QuartzComponentProps } from "../types" -import { Fragment, jsx, jsxs } from 'preact/jsx-runtime' +import { Fragment, jsx, jsxs } from "preact/jsx-runtime" import { toJsxRuntime } from "hast-util-to-jsx-runtime" function Content({ tree }: QuartzComponentProps) { // @ts-ignore (preact makes it angry) - const content = toJsxRuntime(tree, { Fragment, jsx, jsxs, elementAttributeNameCase: 'html' }) + const content = toJsxRuntime(tree, { Fragment, jsx, jsxs, elementAttributeNameCase: "html" }) return
{content}
} diff --git a/quartz/components/pages/FolderContent.tsx b/quartz/components/pages/FolderContent.tsx index 9221eacb..66a1adba 100644 --- a/quartz/components/pages/FolderContent.tsx +++ b/quartz/components/pages/FolderContent.tsx @@ -1,16 +1,16 @@ import { QuartzComponentConstructor, QuartzComponentProps } from "../types" -import { Fragment, jsx, jsxs } from 'preact/jsx-runtime' +import { Fragment, jsx, jsxs } from "preact/jsx-runtime" import { toJsxRuntime } from "hast-util-to-jsx-runtime" import path from "path" -import style from '../styles/listPage.scss' +import style from "../styles/listPage.scss" import { PageList } from "../PageList" import { canonicalizeServer } from "../../path" function FolderContent(props: QuartzComponentProps) { const { tree, fileData, allFiles } = props const folderSlug = canonicalizeServer(fileData.slug!) - const allPagesInFolder = allFiles.filter(file => { + const allPagesInFolder = allFiles.filter((file) => { const fileSlug = file.slug ?? "" const prefixed = fileSlug.startsWith(folderSlug) const folderParts = folderSlug.split(path.posix.sep) @@ -21,18 +21,20 @@ function FolderContent(props: QuartzComponentProps) { const listProps = { ...props, - allFiles: allPagesInFolder + allFiles: allPagesInFolder, } - + // @ts-ignore - const content = toJsxRuntime(tree, { Fragment, jsx, jsxs, elementAttributeNameCase: 'html' }) - return
-
{content}
-

{allPagesInFolder.length} items under this folder.

-
- + const content = toJsxRuntime(tree, { Fragment, jsx, jsxs, elementAttributeNameCase: "html" }) + return ( +
+
{content}
+

{allPagesInFolder.length} items under this folder.

+
+ +
-
+ ) } FolderContent.css = style + PageList.css diff --git a/quartz/components/pages/TagContent.tsx b/quartz/components/pages/TagContent.tsx index a490b8d0..6a3d8274 100644 --- a/quartz/components/pages/TagContent.tsx +++ b/quartz/components/pages/TagContent.tsx @@ -1,7 +1,7 @@ import { QuartzComponentConstructor, QuartzComponentProps } from "../types" -import { Fragment, jsx, jsxs } from 'preact/jsx-runtime' +import { Fragment, jsx, jsxs } from "preact/jsx-runtime" import { toJsxRuntime } from "hast-util-to-jsx-runtime" -import style from '../styles/listPage.scss' +import style from "../styles/listPage.scss" import { PageList } from "../PageList" import { ServerSlug, canonicalizeServer } from "../../path" @@ -11,21 +11,23 @@ function TagContent(props: QuartzComponentProps) { if (slug?.startsWith("tags/")) { const tag = canonicalizeServer(slug.slice("tags/".length) as ServerSlug) - const allPagesWithTag = allFiles.filter(file => (file.frontmatter?.tags ?? []).includes(tag)) + const allPagesWithTag = allFiles.filter((file) => (file.frontmatter?.tags ?? []).includes(tag)) const listProps = { ...props, - allFiles: allPagesWithTag + allFiles: allPagesWithTag, } // @ts-ignore - const content = toJsxRuntime(tree, { Fragment, jsx, jsxs, elementAttributeNameCase: 'html' }) - return
-
{content}
-

{allPagesWithTag.length} items with this tag.

-
- + const content = toJsxRuntime(tree, { Fragment, jsx, jsxs, elementAttributeNameCase: "html" }) + return ( +
+
{content}
+

{allPagesWithTag.length} items with this tag.

+
+ +
-
+ ) } else { throw new Error(`Component "TagContent" tried to render a non-tag page: ${slug}`) } diff --git a/quartz/components/renderPage.tsx b/quartz/components/renderPage.tsx index e5cf5ebf..ab93709c 100644 --- a/quartz/components/renderPage.tsx +++ b/quartz/components/renderPage.tsx @@ -1,21 +1,24 @@ -import { render } from "preact-render-to-string"; -import { QuartzComponent, QuartzComponentProps } from "./types"; +import { render } from "preact-render-to-string" +import { QuartzComponent, QuartzComponentProps } from "./types" import HeaderConstructor from "./Header" import BodyConstructor from "./Body" -import { JSResourceToScriptElement, StaticResources } from "../resources"; -import { CanonicalSlug, pathToRoot } from "../path"; +import { JSResourceToScriptElement, StaticResources } from "../resources" +import { CanonicalSlug, pathToRoot } from "../path" interface RenderComponents { head: QuartzComponent - header: QuartzComponent[], - beforeBody: QuartzComponent[], - pageBody: QuartzComponent, - left: QuartzComponent[], - right: QuartzComponent[], - footer: QuartzComponent, + header: QuartzComponent[] + beforeBody: QuartzComponent[] + pageBody: QuartzComponent + left: QuartzComponent[] + right: QuartzComponent[] + footer: QuartzComponent } -export function pageResources(slug: CanonicalSlug, staticResources: StaticResources): StaticResources { +export function pageResources( + slug: CanonicalSlug, + staticResources: StaticResources, +): StaticResources { const baseDir = pathToRoot(slug) const contentIndexPath = baseDir + "/static/contentIndex.json" @@ -25,52 +28,89 @@ export function pageResources(slug: CanonicalSlug, staticResources: StaticResour css: [baseDir + "/index.css", ...staticResources.css], js: [ { src: baseDir + "/prescript.js", loadTime: "beforeDOMReady", contentType: "external" }, - { loadTime: "beforeDOMReady", contentType: "inline", spaPreserve: true, script: contentIndexScript }, + { + loadTime: "beforeDOMReady", + contentType: "inline", + spaPreserve: true, + script: contentIndexScript, + }, ...staticResources.js, - { src: baseDir + "/postscript.js", loadTime: "afterDOMReady", moduleType: 'module', contentType: "external" } - ] + { + src: baseDir + "/postscript.js", + loadTime: "afterDOMReady", + moduleType: "module", + contentType: "external", + }, + ], } } -export function renderPage(slug: CanonicalSlug, componentData: QuartzComponentProps, components: RenderComponents, pageResources: StaticResources): string { - const { head: Head, header, beforeBody, pageBody: Content, left, right, footer: Footer } = components +export function renderPage( + slug: CanonicalSlug, + componentData: QuartzComponentProps, + components: RenderComponents, + pageResources: StaticResources, +): string { + const { + head: Head, + header, + beforeBody, + pageBody: Content, + left, + right, + footer: Footer, + } = components const Header = HeaderConstructor() const Body = BodyConstructor() - const LeftComponent = + const LeftComponent = (
- {left.map(BodyComponent => )} + {left.map((BodyComponent) => ( + + ))}
+ ) - const RightComponent = + const RightComponent = (
- {right.map(BodyComponent => )} + {right.map((BodyComponent) => ( + + ))}
+ ) - const doc = - - -
- - {LeftComponent} -
-
-
- {header.map(HeaderComponent => )} -
-
- {beforeBody.map(BodyComponent => )} + const doc = ( + + + +
+ + {LeftComponent} +
+
+
+ {header.map((HeaderComponent) => ( + + ))} +
+
+ {beforeBody.map((BodyComponent) => ( + + ))} +
+
- -
- {RightComponent} - -
-
- - {pageResources.js.filter(resource => resource.loadTime === "afterDOMReady").map(res => JSResourceToScriptElement(res))} - + {RightComponent} + +
+
+ + {pageResources.js + .filter((resource) => resource.loadTime === "afterDOMReady") + .map((res) => JSResourceToScriptElement(res))} + + ) return "\n" + render(doc) } diff --git a/quartz/components/scripts/callout.inline.ts b/quartz/components/scripts/callout.inline.ts index c13571ab..556ef3cd 100644 --- a/quartz/components/scripts/callout.inline.ts +++ b/quartz/components/scripts/callout.inline.ts @@ -7,7 +7,9 @@ function toggleCallout(this: HTMLElement) { } function setupCallout() { - const collapsible = document.getElementsByClassName(`callout is-collapsible`) as HTMLCollectionOf + const collapsible = document.getElementsByClassName( + `callout is-collapsible`, + ) as HTMLCollectionOf for (const div of collapsible) { const title = div.firstElementChild diff --git a/quartz/components/scripts/darkmode.inline.ts b/quartz/components/scripts/darkmode.inline.ts index 594bd3a9..e16f4f84 100644 --- a/quartz/components/scripts/darkmode.inline.ts +++ b/quartz/components/scripts/darkmode.inline.ts @@ -1,24 +1,23 @@ -const userPref = window.matchMedia('(prefers-color-scheme: light)').matches ? 'light' : 'dark' -const currentTheme = localStorage.getItem('theme') ?? userPref -document.documentElement.setAttribute('saved-theme', currentTheme) +const userPref = window.matchMedia("(prefers-color-scheme: light)").matches ? "light" : "dark" +const currentTheme = localStorage.getItem("theme") ?? userPref +document.documentElement.setAttribute("saved-theme", currentTheme) document.addEventListener("nav", () => { const switchTheme = (e: any) => { if (e.target.checked) { - document.documentElement.setAttribute('saved-theme', 'dark') - localStorage.setItem('theme', 'dark') - } - else { - document.documentElement.setAttribute('saved-theme', 'light') - localStorage.setItem('theme', 'light') + document.documentElement.setAttribute("saved-theme", "dark") + localStorage.setItem("theme", "dark") + } else { + document.documentElement.setAttribute("saved-theme", "light") + localStorage.setItem("theme", "light") } } // Darkmode toggle - const toggleSwitch = document.querySelector('#darkmode-toggle') as HTMLInputElement - toggleSwitch.removeEventListener('change', switchTheme) - toggleSwitch.addEventListener('change', switchTheme) - if (currentTheme === 'dark') { + const toggleSwitch = document.querySelector("#darkmode-toggle") as HTMLInputElement + toggleSwitch.removeEventListener("change", switchTheme) + toggleSwitch.addEventListener("change", switchTheme) + if (currentTheme === "dark") { toggleSwitch.checked = true } }) diff --git a/quartz/components/scripts/graph.inline.ts b/quartz/components/scripts/graph.inline.ts index ae4f40f8..bd57f7d9 100644 --- a/quartz/components/scripts/graph.inline.ts +++ b/quartz/components/scripts/graph.inline.ts @@ -1,16 +1,16 @@ import { ContentDetails } from "../../plugins/emitters/contentIndex" -import * as d3 from 'd3' +import * as d3 from "d3" import { registerEscapeHandler, removeAllChildren } from "./util" import { CanonicalSlug, getCanonicalSlug, getClientSlug, resolveRelative } from "../../path" type NodeData = { - id: CanonicalSlug, - text: string, + id: CanonicalSlug + text: string tags: string[] } & d3.SimulationNodeDatum type LinkData = { - source: CanonicalSlug, + source: CanonicalSlug target: CanonicalSlug } @@ -40,7 +40,7 @@ async function renderGraph(container: string, slug: CanonicalSlug) { centerForce, linkDistance, fontSize, - opacityScale + opacityScale, } = JSON.parse(graph.dataset["cfg"]!) const data = await fetchData @@ -66,18 +66,22 @@ async function renderGraph(container: string, slug: CanonicalSlug) { wl.push("__SENTINEL") } else { neighbourhood.add(cur) - const outgoing = links.filter(l => l.source === cur) - const incoming = links.filter(l => l.target === cur) + const outgoing = links.filter((l) => l.source === cur) + const incoming = links.filter((l) => l.target === cur) wl.push(...outgoing.map((l) => l.target), ...incoming.map((l) => l.source)) } } } else { - Object.keys(data).forEach(id => neighbourhood.add(id as CanonicalSlug)) + Object.keys(data).forEach((id) => neighbourhood.add(id as CanonicalSlug)) } - const graphData: { nodes: NodeData[], links: LinkData[] } = { - nodes: [...neighbourhood].map(url => ({ id: url, text: data[url]?.title ?? url, tags: data[url]?.tags ?? [] })), - links: links.filter((l) => neighbourhood.has(l.source) && neighbourhood.has(l.target)) + const graphData: { nodes: NodeData[]; links: LinkData[] } = { + nodes: [...neighbourhood].map((url) => ({ + id: url, + text: data[url]?.title ?? url, + tags: data[url]?.tags ?? [], + })), + links: links.filter((l) => neighbourhood.has(l.source) && neighbourhood.has(l.target)), } const simulation: d3.Simulation = d3 @@ -96,11 +100,11 @@ async function renderGraph(container: string, slug: CanonicalSlug) { const width = graph.offsetWidth const svg = d3 - .select('#' + container) + .select("#" + container) .append("svg") .attr("width", width) .attr("height", height) - .attr('viewBox', [-width / 2 / scale, -height / 2 / scale, width / scale, height / scale]) + .attr("viewBox", [-width / 2 / scale, -height / 2 / scale, width / scale, height / scale]) // draw links between nodes const link = svg @@ -145,7 +149,7 @@ async function renderGraph(container: string, slug: CanonicalSlug) { d.fy = null } - const noop = () => { } + const noop = () => {} return d3 .drag() .on("start", enableDrag ? dragstarted : noop) @@ -170,9 +174,11 @@ async function renderGraph(container: string, slug: CanonicalSlug) { const targ = resolveRelative(slug, d.id) window.spaNavigate(new URL(targ, getClientSlug(window))) }) - .on("mouseover", function(_, d) { + .on("mouseover", function (_, d) { const neighbours: CanonicalSlug[] = data[slug].links ?? [] - const neighbourNodes = d3.selectAll(".node").filter((d) => neighbours.includes(d.id)) + const neighbourNodes = d3 + .selectAll(".node") + .filter((d) => neighbours.includes(d.id)) console.log(neighbourNodes) const currentId = d.id const linkNodes = d3 @@ -183,12 +189,7 @@ async function renderGraph(container: string, slug: CanonicalSlug) { neighbourNodes.transition().duration(200).attr("fill", color) // highlight links - linkNodes - .transition() - .duration(200) - .attr("stroke", "var(--gray)") - .attr("stroke-width", 1) - + linkNodes.transition().duration(200).attr("stroke", "var(--gray)").attr("stroke-width", 1) const bigFont = fontSize * 1.5 @@ -199,11 +200,11 @@ async function renderGraph(container: string, slug: CanonicalSlug) { .select("text") .transition() .duration(200) - .attr('opacityOld', d3.select(parent).select('text').style("opacity")) - .style('opacity', 1) - .style('font-size', bigFont + 'em') + .attr("opacityOld", d3.select(parent).select("text").style("opacity")) + .style("opacity", 1) + .style("font-size", bigFont + "em") }) - .on("mouseleave", function(_, d) { + .on("mouseleave", function (_, d) { const currentId = d.id const linkNodes = d3 .selectAll(".link") @@ -216,8 +217,8 @@ async function renderGraph(container: string, slug: CanonicalSlug) { .select("text") .transition() .duration(200) - .style('opacity', d3.select(parent).select('text').attr("opacityOld")) - .style('font-size', fontSize + 'em') + .style("opacity", d3.select(parent).select("text").attr("opacityOld")) + .style("font-size", fontSize + "em") }) // @ts-ignore .call(drag(simulation)) @@ -228,10 +229,12 @@ async function renderGraph(container: string, slug: CanonicalSlug) { .attr("dx", 0) .attr("dy", (d) => -nodeRadius(d) + "px") .attr("text-anchor", "middle") - .text((d) => data[d.id]?.title || (d.id.charAt(1).toUpperCase() + d.id.slice(2)).replace("-", " ")) - .style('opacity', (opacityScale - 1) / 3.75) + .text( + (d) => data[d.id]?.title || (d.id.charAt(1).toUpperCase() + d.id.slice(2)).replace("-", " "), + ) + .style("opacity", (opacityScale - 1) / 3.75) .style("pointer-events", "none") - .style('font-size', fontSize + 'em') + .style("font-size", fontSize + "em") .raise() // @ts-ignore .call(drag(simulation)) @@ -249,7 +252,7 @@ async function renderGraph(container: string, slug: CanonicalSlug) { .on("zoom", ({ transform }) => { link.attr("transform", transform) node.attr("transform", transform) - const scale = transform.k * opacityScale; + const scale = transform.k * opacityScale const scaledOpacity = Math.max((scale - 1) / 3.75, 0) labels.attr("transform", transform).style("opacity", scaledOpacity) }), @@ -263,17 +266,13 @@ async function renderGraph(container: string, slug: CanonicalSlug) { .attr("y1", (d: any) => d.source.y) .attr("x2", (d: any) => d.target.x) .attr("y2", (d: any) => d.target.y) - node - .attr("cx", (d: any) => d.x) - .attr("cy", (d: any) => d.y) - labels - .attr("x", (d: any) => d.x) - .attr("y", (d: any) => d.y) + node.attr("cx", (d: any) => d.x).attr("cy", (d: any) => d.y) + labels.attr("x", (d: any) => d.x).attr("y", (d: any) => d.y) }) } function renderGlobalGraph() { - const slug = getCanonicalSlug(window) + const slug = getCanonicalSlug(window) const container = document.getElementById("global-graph-outer") const sidebar = container?.closest(".sidebar") as HTMLElement container?.classList.add("active") @@ -305,4 +304,3 @@ document.addEventListener("nav", async (e: unknown) => { containerIcon?.removeEventListener("click", renderGlobalGraph) containerIcon?.addEventListener("click", renderGlobalGraph) }) - diff --git a/quartz/components/scripts/plausible.inline.ts b/quartz/components/scripts/plausible.inline.ts index 60817c29..704f5d5f 100644 --- a/quartz/components/scripts/plausible.inline.ts +++ b/quartz/components/scripts/plausible.inline.ts @@ -1,3 +1,3 @@ -import Plausible from 'plausible-tracker' +import Plausible from "plausible-tracker" const { trackPageview } = Plausible() document.addEventListener("nav", () => trackPageview()) diff --git a/quartz/components/scripts/popover.inline.ts b/quartz/components/scripts/popover.inline.ts index 666371b0..ed3c925c 100644 --- a/quartz/components/scripts/popover.inline.ts +++ b/quartz/components/scripts/popover.inline.ts @@ -2,33 +2,25 @@ import { computePosition, flip, inline, shift } from "@floating-ui/dom" // from micromorph/src/utils.ts // https://github.com/natemoo-re/micromorph/blob/main/src/utils.ts#L5 -export function normalizeRelativeURLs( - el: Element | Document, - base: string | URL -) { +export function normalizeRelativeURLs(el: Element | Document, base: string | URL) { const update = (el: Element, attr: string, base: string | URL) => { el.setAttribute(attr, new URL(el.getAttribute(attr)!, base).pathname) } - el.querySelectorAll('[href^="./"], [href^="../"]').forEach((item) => - update(item, 'href', base) - ) + el.querySelectorAll('[href^="./"], [href^="../"]').forEach((item) => update(item, "href", base)) - el.querySelectorAll('[src^="./"], [src^="../"]').forEach((item) => - update(item, 'src', base) - ) + el.querySelectorAll('[src^="./"], [src^="../"]').forEach((item) => update(item, "src", base)) } const p = new DOMParser() -async function mouseEnterHandler(this: HTMLLinkElement, { clientX, clientY }: { clientX: number, clientY: number }) { +async function mouseEnterHandler( + this: HTMLLinkElement, + { clientX, clientY }: { clientX: number; clientY: number }, +) { const link = this async function setPosition(popoverElement: HTMLElement) { const { x, y } = await computePosition(link, popoverElement, { - middleware: [ - inline({ x: clientX, y: clientY }), - shift(), - flip() - ] + middleware: [inline({ x: clientX, y: clientY }), shift(), flip()], }) Object.assign(popoverElement.style, { left: `${x}px`, @@ -37,7 +29,7 @@ async function mouseEnterHandler(this: HTMLLinkElement, { clientX, clientY }: { } // dont refetch if there's already a popover - if ([...link.children].some(child => child.classList.contains("popover"))) { + if ([...link.children].some((child) => child.classList.contains("popover"))) { return setPosition(link.lastChild as HTMLElement) } @@ -68,7 +60,7 @@ async function mouseEnterHandler(this: HTMLLinkElement, { clientX, clientY }: { const popoverInner = document.createElement("div") popoverInner.classList.add("popover-inner") popoverElement.appendChild(popoverInner) - elts.forEach(elt => popoverInner.appendChild(elt)) + elts.forEach((elt) => popoverInner.appendChild(elt)) setPosition(popoverElement) link.appendChild(popoverElement) @@ -77,7 +69,7 @@ async function mouseEnterHandler(this: HTMLLinkElement, { clientX, clientY }: { const heading = popoverInner.querySelector(hash) as HTMLElement | null if (heading) { // leave ~12px of buffer when scrolling to a heading - popoverInner.scroll({ top: heading.offsetTop - 12, behavior: 'instant' }) + popoverInner.scroll({ top: heading.offsetTop - 12, behavior: "instant" }) } } } diff --git a/quartz/components/scripts/search.inline.ts b/quartz/components/scripts/search.inline.ts index c738fc98..40d0bc20 100644 --- a/quartz/components/scripts/search.inline.ts +++ b/quartz/components/scripts/search.inline.ts @@ -4,9 +4,9 @@ import { registerEscapeHandler, removeAllChildren } from "./util" import { CanonicalSlug, getClientSlug, resolveRelative } from "../../path" interface Item { - slug: CanonicalSlug, - title: string, - content: string, + slug: CanonicalSlug + title: string + content: string } let index: Document | undefined = undefined @@ -15,15 +15,17 @@ const contextWindowWords = 30 const numSearchResults = 5 function highlight(searchTerm: string, text: string, trim?: boolean) { // try to highlight longest tokens first - const tokenizedTerms = searchTerm.split(/\s+/).filter(t => t !== "").sort((a, b) => b.length - a.length) - let tokenizedText = text + const tokenizedTerms = searchTerm .split(/\s+/) - .filter(t => t !== "") + .filter((t) => t !== "") + .sort((a, b) => b.length - a.length) + let tokenizedText = text.split(/\s+/).filter((t) => t !== "") let startIndex = 0 let endIndex = tokenizedText.length - 1 if (trim) { - const includesCheck = (tok: string) => tokenizedTerms.some((term) => tok.toLowerCase().startsWith(term.toLowerCase())) + const includesCheck = (tok: string) => + tokenizedTerms.some((term) => tok.toLowerCase().startsWith(term.toLowerCase())) const occurencesIndices = tokenizedText.map(includesCheck) let bestSum = 0 @@ -42,19 +44,22 @@ function highlight(searchTerm: string, text: string, trim?: boolean) { tokenizedText = tokenizedText.slice(startIndex, endIndex) } - const slice = tokenizedText.map(tok => { - // see if this tok is prefixed by any search terms - for (const searchTok of tokenizedTerms) { - if (tok.toLowerCase().includes(searchTok.toLowerCase())) { - const regex = new RegExp(searchTok.toLowerCase(), "gi") - return tok.replace(regex, `$&`) + const slice = tokenizedText + .map((tok) => { + // see if this tok is prefixed by any search terms + for (const searchTok of tokenizedTerms) { + if (tok.toLowerCase().includes(searchTok.toLowerCase())) { + const regex = new RegExp(searchTok.toLowerCase(), "gi") + return tok.replace(regex, `$&`) + } } - } - return tok - }) + return tok + }) .join(" ") - return `${startIndex === 0 ? "" : "..."}${slice}${endIndex === tokenizedText.length - 1 ? "" : "..."}` + return `${startIndex === 0 ? "" : "..."}${slice}${ + endIndex === tokenizedText.length - 1 ? "" : "..." + }` } const encoder = (str: string) => str.toLowerCase().split(/([^a-z]|[^\x00-\x7F])/) @@ -113,7 +118,7 @@ document.addEventListener("nav", async (e: unknown) => { button.classList.add("result-card") button.id = slug button.innerHTML = `

${title}

${content}

` - button.addEventListener('click', () => { + button.addEventListener("click", () => { const targ = resolveRelative(currentSlug, slug) window.spaNavigate(new URL(targ, getClientSlug(window))) }) @@ -132,7 +137,6 @@ document.addEventListener("nav", async (e: unknown) => { } else { results.append(...finalResults.map(resultToHTML)) } - } function onType(e: HTMLElementEventMap["input"]) { @@ -140,12 +144,12 @@ document.addEventListener("nav", async (e: unknown) => { const searchResults = index?.search(term, numSearchResults) ?? [] const getByField = (field: string): CanonicalSlug[] => { const results = searchResults.filter((x) => x.field === field) - return results.length === 0 ? [] : [...results[0].result] as CanonicalSlug[] + return results.length === 0 ? [] : ([...results[0].result] as CanonicalSlug[]) } // order titles ahead of content const allIds: Set = new Set([...getByField("title"), ...getByField("content")]) - const finalResults = [...allIds].map(id => formatForDisplay(term, id)) + const finalResults = [...allIds].map((id) => formatForDisplay(term, id)) displayResults(finalResults) } @@ -160,7 +164,7 @@ document.addEventListener("nav", async (e: unknown) => { if (!index) { index = new Document({ cache: true, - charset: 'latin:extra', + charset: "latin:extra", optimize: true, encode: encoder, document: { @@ -174,7 +178,7 @@ document.addEventListener("nav", async (e: unknown) => { field: "content", tokenize: "reverse", }, - ] + ], }, }) @@ -182,7 +186,7 @@ document.addEventListener("nav", async (e: unknown) => { await index.addAsync(slug, { slug: slug as CanonicalSlug, title: fileData.title, - content: fileData.content + content: fileData.content, }) } } diff --git a/quartz/components/scripts/spa.inline.ts b/quartz/components/scripts/spa.inline.ts index 774326ef..4d31b5e2 100644 --- a/quartz/components/scripts/spa.inline.ts +++ b/quartz/components/scripts/spa.inline.ts @@ -5,8 +5,9 @@ import { CanonicalSlug, RelativeURL, getCanonicalSlug } from "../../path" // https://github.com/natemoo-re/micromorph const NODE_TYPE_ELEMENT = 1 -let announcer = document.createElement('route-announcer') -const isElement = (target: EventTarget | null): target is Element => (target as Node)?.nodeType === NODE_TYPE_ELEMENT +let announcer = document.createElement("route-announcer") +const isElement = (target: EventTarget | null): target is Element => + (target as Node)?.nodeType === NODE_TYPE_ELEMENT const isLocalUrl = (href: string) => { try { const url = new URL(href) @@ -16,18 +17,18 @@ const isLocalUrl = (href: string) => { } return true } - } catch (e) { } + } catch (e) {} return false } -const getOpts = ({ target }: Event): { url: URL, scroll?: boolean } | undefined => { +const getOpts = ({ target }: Event): { url: URL; scroll?: boolean } | undefined => { if (!isElement(target)) return const a = target.closest("a") if (!a) return - if ('routerIgnore' in a.dataset) return + if ("routerIgnore" in a.dataset) return const { href } = a if (!isLocalUrl(href)) return - return { url: new URL(href), scroll: 'routerNoscroll' in a.dataset ? false : undefined } + return { url: new URL(href), scroll: "routerNoscroll" in a.dataset ? false : undefined } } function notifyNav(url: CanonicalSlug) { @@ -44,7 +45,7 @@ async function navigate(url: URL, isBack: boolean = false) { window.location.assign(url) }) - if (!contents) return; + if (!contents) return if (!isBack) { history.pushState({}, "", url) window.scrollTo({ top: 0 }) @@ -54,22 +55,22 @@ async function navigate(url: URL, isBack: boolean = false) { if (title) { document.title = title } else { - const h1 = document.querySelector('h1') + const h1 = document.querySelector("h1") title = h1?.innerText ?? h1?.textContent ?? url.pathname } if (announcer.textContent !== title) { announcer.textContent = title } - announcer.dataset.persist = '' + announcer.dataset.persist = "" html.body.appendChild(announcer) micromorph(document.body, html.body) - // now, patch head - const elementsToRemove = document.head.querySelectorAll(':not([spa-preserve])') - elementsToRemove.forEach(el => el.remove()) - const elementsToAdd = html.head.querySelectorAll(':not([spa-preserve])') - elementsToAdd.forEach(el => document.head.appendChild(el)) + // now, patch head + const elementsToRemove = document.head.querySelectorAll(":not([spa-preserve])") + elementsToRemove.forEach((el) => el.remove()) + const elementsToAdd = html.head.querySelectorAll(":not([spa-preserve])") + elementsToAdd.forEach((el) => document.head.appendChild(el)) notifyNav(getCanonicalSlug(window)) delete announcer.dataset.persist @@ -101,7 +102,7 @@ function createRouter() { }) } - return new class Router { + return new (class Router { go(pathname: RelativeURL) { const url = new URL(pathname, window.location.toString()) return navigate(url, false) @@ -114,26 +115,30 @@ function createRouter() { forward() { return window.history.forward() } - } + })() } createRouter() notifyNav(getCanonicalSlug(window)) -if (!customElements.get('route-announcer')) { +if (!customElements.get("route-announcer")) { const attrs = { - 'aria-live': 'assertive', - 'aria-atomic': 'true', - 'style': 'position: absolute; left: 0; top: 0; clip: rect(0 0 0 0); clip-path: inset(50%); overflow: hidden; white-space: nowrap; width: 1px; height: 1px' + "aria-live": "assertive", + "aria-atomic": "true", + style: + "position: absolute; left: 0; top: 0; clip: rect(0 0 0 0); clip-path: inset(50%); overflow: hidden; white-space: nowrap; width: 1px; height: 1px", } - customElements.define('route-announcer', class RouteAnnouncer extends HTMLElement { - constructor() { - super() - } - connectedCallback() { - for (const [key, value] of Object.entries(attrs)) { - this.setAttribute(key, value) + customElements.define( + "route-announcer", + class RouteAnnouncer extends HTMLElement { + constructor() { + super() } - } - }) + connectedCallback() { + for (const [key, value] of Object.entries(attrs)) { + this.setAttribute(key, value) + } + } + }, + ) } diff --git a/quartz/components/scripts/toc.inline.ts b/quartz/components/scripts/toc.inline.ts index d6cd50af..f33d8f50 100644 --- a/quartz/components/scripts/toc.inline.ts +++ b/quartz/components/scripts/toc.inline.ts @@ -1,5 +1,5 @@ const bufferPx = 150 -const observer = new IntersectionObserver(entries => { +const observer = new IntersectionObserver((entries) => { for (const entry of entries) { const slug = entry.target.id const tocEntryElement = document.querySelector(`a[data-for="${slug}"]`) @@ -38,5 +38,5 @@ document.addEventListener("nav", () => { // update toc entry highlighting observer.disconnect() const headers = document.querySelectorAll("h1[id], h2[id], h3[id], h4[id], h5[id], h6[id]") - headers.forEach(header => observer.observe(header)) + headers.forEach((header) => observer.observe(header)) }) diff --git a/quartz/components/scripts/util.ts b/quartz/components/scripts/util.ts index a97faa6e..5fcabadc 100644 --- a/quartz/components/scripts/util.ts +++ b/quartz/components/scripts/util.ts @@ -15,7 +15,7 @@ export function registerEscapeHandler(outsideContainer: HTMLElement | null, cb: outsideContainer?.removeEventListener("click", click) outsideContainer?.addEventListener("click", click) document.removeEventListener("keydown", esc) - document.addEventListener('keydown', esc) + document.addEventListener("keydown", esc) } export function removeAllChildren(node: HTMLElement) { diff --git a/quartz/components/styles/graph.scss b/quartz/components/styles/graph.scss index 435be79f..3deaa1fe 100644 --- a/quartz/components/styles/graph.scss +++ b/quartz/components/styles/graph.scss @@ -3,7 +3,7 @@ .graph { & > h3 { font-size: 1rem; - margin: 0 + margin: 0; } & > .graph-outer { @@ -26,7 +26,7 @@ top: 0; right: 0; border-radius: 4px; - background-color: transparent; + background-color: transparent; transition: background-color 0.5s ease; cursor: pointer; &:hover { @@ -52,7 +52,7 @@ & > #global-graph-container { border: 1px solid var(--lightgray); - background-color: var(--light); + background-color: var(--light); border-radius: 5px; box-sizing: border-box; position: fixed; diff --git a/quartz/components/styles/legacyToc.scss b/quartz/components/styles/legacyToc.scss index 8889dcce..7a98f343 100644 --- a/quartz/components/styles/legacyToc.scss +++ b/quartz/components/styles/legacyToc.scss @@ -12,7 +12,7 @@ details#toc { margin: 0; } } - + & ul { list-style: none; margin: 0.5rem 1.25rem; diff --git a/quartz/components/styles/listPage.scss b/quartz/components/styles/listPage.scss index 6c8e1b58..7105a1e8 100644 --- a/quartz/components/styles/listPage.scss +++ b/quartz/components/styles/listPage.scss @@ -25,7 +25,7 @@ li.section-li { } & > .desc > h3 > a { - background-color: transparent; + background-color: transparent; } & > .meta { diff --git a/quartz/components/styles/popover.scss b/quartz/components/styles/popover.scss index 2bc1af1d..3616e515 100644 --- a/quartz/components/styles/popover.scss +++ b/quartz/components/styles/popover.scss @@ -32,7 +32,7 @@ border: 1px solid var(--lightgray); background-color: var(--light); border-radius: 5px; - box-shadow: 6px 6px 36px 0 rgba(0,0,0,0.25); + box-shadow: 6px 6px 36px 0 rgba(0, 0, 0, 0.25); overflow: auto; } @@ -42,14 +42,17 @@ visibility: hidden; opacity: 0; - transition: opacity 0.3s ease, visibility 0.3s ease; + transition: + opacity 0.3s ease, + visibility 0.3s ease; @media all and (max-width: $mobileBreakpoint) { display: none !important; } } -a:hover .popover, .popover:hover { +a:hover .popover, +.popover:hover { animation: dropin 0.3s ease; animation-fill-mode: forwards; animation-delay: 0.2s; diff --git a/quartz/components/styles/search.scss b/quartz/components/styles/search.scss index fe94ec7e..5b331cce 100644 --- a/quartz/components/styles/search.scss +++ b/quartz/components/styles/search.scss @@ -67,7 +67,9 @@ width: 100%; border-radius: 5px; background: var(--light); - box-shadow: 0 14px 50px rgba(27, 33, 48, 0.12), 0 10px 30px rgba(27, 33, 48, 0.16); + box-shadow: + 0 14px 50px rgba(27, 33, 48, 0.12), + 0 10px 30px rgba(27, 33, 48, 0.16); margin-bottom: 2em; } @@ -108,7 +110,8 @@ font-weight: 700; } - &:hover, &:focus { + &:hover, + &:focus { background: var(--lightgray); } @@ -127,12 +130,11 @@ margin: 0; } - & > p { + & > p { margin-bottom: 0; } } } - } } } diff --git a/quartz/components/styles/toc.scss b/quartz/components/styles/toc.scss index 9c0a4b2c..3fac4432 100644 --- a/quartz/components/styles/toc.scss +++ b/quartz/components/styles/toc.scss @@ -15,16 +15,16 @@ button#toc { } & .fold { - margin-left: 0.5rem; + margin-left: 0.5rem; transition: transform 0.3s ease; opacity: 0.8; } &.collapsed .fold { - transform: rotateZ(-90deg) + transform: rotateZ(-90deg); } } - + #toc-content { list-style: none; overflow: hidden; @@ -42,7 +42,9 @@ button#toc { & > li > a { color: var(--dark); opacity: 0.35; - transition: 0.5s ease opacity, 0.3s ease color; + transition: + 0.5s ease opacity, + 0.3s ease color; &.in-view { opacity: 0.75; } @@ -55,4 +57,3 @@ button#toc { } } } - diff --git a/quartz/components/types.ts b/quartz/components/types.ts index b37ccee1..803ada91 100644 --- a/quartz/components/types.ts +++ b/quartz/components/types.ts @@ -11,15 +11,17 @@ export type QuartzComponentProps = { children: (QuartzComponent | JSX.Element)[] tree: Node allFiles: QuartzPluginData[] - displayClass?: 'mobile-only' | 'desktop-only' + displayClass?: "mobile-only" | "desktop-only" } & JSX.IntrinsicAttributes & { - [key: string]: any -} + [key: string]: any + } export type QuartzComponent = ComponentType & { - css?: string, - beforeDOMLoaded?: string, - afterDOMLoaded?: string, + css?: string + beforeDOMLoaded?: string + afterDOMLoaded?: string } -export type QuartzComponentConstructor = (opts: Options) => QuartzComponent +export type QuartzComponentConstructor = ( + opts: Options, +) => QuartzComponent diff --git a/quartz/log.ts b/quartz/log.ts index f96cfe4c..73e5d7e2 100644 --- a/quartz/log.ts +++ b/quartz/log.ts @@ -1,4 +1,4 @@ -import { Spinner } from 'cli-spinner' +import { Spinner } from "cli-spinner" export class QuartzLogger { verbose: boolean diff --git a/quartz/path.test.ts b/quartz/path.test.ts index 674f683f..614273f8 100644 --- a/quartz/path.test.ts +++ b/quartz/path.test.ts @@ -1,9 +1,9 @@ -import test, { describe } from 'node:test' -import * as path from './path' -import assert from 'node:assert' +import test, { describe } from "node:test" +import * as path from "./path" +import assert from "node:assert" -describe('typeguards', () => { - test('isClientSlug', () => { +describe("typeguards", () => { + test("isClientSlug", () => { assert(path.isClientSlug("http://example.com")) assert(path.isClientSlug("http://example.com/index")) assert(path.isClientSlug("http://example.com/index.html")) @@ -23,7 +23,7 @@ describe('typeguards', () => { assert(!path.isClientSlug("https")) }) - test('isCanonicalSlug', () => { + test("isCanonicalSlug", () => { assert(path.isCanonicalSlug("")) assert(path.isCanonicalSlug("abc")) assert(path.isCanonicalSlug("notindex")) @@ -41,7 +41,7 @@ describe('typeguards', () => { assert(!path.isCanonicalSlug("index.html")) }) - test('isRelativeURL', () => { + test("isRelativeURL", () => { assert(path.isRelativeURL(".")) assert(path.isRelativeURL("..")) assert(path.isRelativeURL("./abc/def")) @@ -58,7 +58,7 @@ describe('typeguards', () => { assert(!path.isRelativeURL("./abc/def.md")) }) - test('isServerSlug', () => { + test("isServerSlug", () => { assert(path.isServerSlug("index")) assert(path.isServerSlug("abc/def")) @@ -72,7 +72,7 @@ describe('typeguards', () => { assert(!path.isServerSlug("note with spaces")) }) - test('isFilePath', () => { + test("isFilePath", () => { assert(path.isFilePath("content/index.md")) assert(path.isFilePath("content/test.png")) assert(!path.isFilePath("../test.pdf")) @@ -81,80 +81,112 @@ describe('typeguards', () => { }) }) - -describe('transforms', () => { - function asserts(pairs: [string, string][], transform: (inp: Inp) => Out, checkPre: (x: any) => x is Inp, checkPost: (x: any) => x is Out) { +describe("transforms", () => { + function asserts( + pairs: [string, string][], + transform: (inp: Inp) => Out, + checkPre: (x: any) => x is Inp, + checkPost: (x: any) => x is Out, + ) { for (const [inp, expected] of pairs) { assert(checkPre(inp), `${inp} wasn't the expected input type`) const actual = transform(inp) - assert.strictEqual(actual, expected, `after transforming ${inp}, '${actual}' was not '${expected}'`) + assert.strictEqual( + actual, + expected, + `after transforming ${inp}, '${actual}' was not '${expected}'`, + ) assert(checkPost(actual), `${actual} wasn't the expected output type`) } } - test('canonicalizeServer', () => { - asserts([ - ["index", ""], - ["abc/index", "abc"], - ["abc/def", "abc/def"], - ], path.canonicalizeServer, path.isServerSlug, path.isCanonicalSlug) + test("canonicalizeServer", () => { + asserts( + [ + ["index", ""], + ["abc/index", "abc"], + ["abc/def", "abc/def"], + ], + path.canonicalizeServer, + path.isServerSlug, + path.isCanonicalSlug, + ) }) - test('canonicalizeClient', () => { - asserts([ - ["http://localhost:3000", ""], - ["http://localhost:3000/index", ""], - ["http://localhost:3000/test", "test"], - ["http://example.com", ""], - ["http://example.com/index", ""], - ["http://example.com/index.html", ""], - ["http://example.com/", ""], - ["https://example.com", ""], - ["https://example.com/abc/def", "abc/def"], - ["https://example.com/abc/def/", "abc/def"], - ["https://example.com/abc/def#cool", "abc/def"], - ["https://example.com/abc/def?field=1&another=2", "abc/def"], - ["https://example.com/abc/def?field=1&another=2#cool", "abc/def"], - ["https://example.com/abc/def.html?field=1&another=2#cool", "abc/def"], - ], path.canonicalizeClient, path.isClientSlug, path.isCanonicalSlug) + test("canonicalizeClient", () => { + asserts( + [ + ["http://localhost:3000", ""], + ["http://localhost:3000/index", ""], + ["http://localhost:3000/test", "test"], + ["http://example.com", ""], + ["http://example.com/index", ""], + ["http://example.com/index.html", ""], + ["http://example.com/", ""], + ["https://example.com", ""], + ["https://example.com/abc/def", "abc/def"], + ["https://example.com/abc/def/", "abc/def"], + ["https://example.com/abc/def#cool", "abc/def"], + ["https://example.com/abc/def?field=1&another=2", "abc/def"], + ["https://example.com/abc/def?field=1&another=2#cool", "abc/def"], + ["https://example.com/abc/def.html?field=1&another=2#cool", "abc/def"], + ], + path.canonicalizeClient, + path.isClientSlug, + path.isCanonicalSlug, + ) }) - describe('slugifyFilePath', () => { - asserts([ - ["content/index.md", "content/index"], - ["content/_index.md", "content/index"], - ["/content/index.md", "content/index"], - ["content/cool.png", "content/cool"], - ["index.md", "index"], - ["note with spaces.md", "note-with-spaces"], - ], path.slugifyFilePath, path.isFilePath, path.isServerSlug) + describe("slugifyFilePath", () => { + asserts( + [ + ["content/index.md", "content/index"], + ["content/_index.md", "content/index"], + ["/content/index.md", "content/index"], + ["content/cool.png", "content/cool"], + ["index.md", "index"], + ["note with spaces.md", "note-with-spaces"], + ], + path.slugifyFilePath, + path.isFilePath, + path.isServerSlug, + ) }) - describe('transformInternalLink', () => { - asserts([ - ["", "."], - [".", "."], - ["./", "."], - ["./index", "."], - ["./index.html", "."], - ["./index.md", "."], - ["content", "./content"], - ["content/test.md", "./content/test"], - ["./content/test.md", "./content/test"], - ["../content/test.md", "../content/test"], - ["tags/", "./tags"], - ["/tags/", "./tags"], - ["content/with spaces", "./content/with-spaces"], - ["content/with spaces#and Anchor!", "./content/with-spaces#and-anchor"], - ], path.transformInternalLink, (_x: string): _x is string => true, path.isRelativeURL) + describe("transformInternalLink", () => { + asserts( + [ + ["", "."], + [".", "."], + ["./", "."], + ["./index", "."], + ["./index.html", "."], + ["./index.md", "."], + ["content", "./content"], + ["content/test.md", "./content/test"], + ["./content/test.md", "./content/test"], + ["../content/test.md", "../content/test"], + ["tags/", "./tags"], + ["/tags/", "./tags"], + ["content/with spaces", "./content/with-spaces"], + ["content/with spaces#and Anchor!", "./content/with-spaces#and-anchor"], + ], + path.transformInternalLink, + (_x: string): _x is string => true, + path.isRelativeURL, + ) }) - describe('pathToRoot', () => { - asserts([ - ["", "."], - ["abc", ".."], - ["abc/def", "../.."], - ], path.pathToRoot, path.isCanonicalSlug, path.isRelativeURL) + describe("pathToRoot", () => { + asserts( + [ + ["", "."], + ["abc", ".."], + ["abc/def", "../.."], + ], + path.pathToRoot, + path.isCanonicalSlug, + path.isRelativeURL, + ) }) }) - diff --git a/quartz/path.ts b/quartz/path.ts index 5e1feb22..0d3a0c6e 100644 --- a/quartz/path.ts +++ b/quartz/path.ts @@ -1,5 +1,5 @@ -import { slug as slugAnchor } from 'github-slugger' -import { trace } from './trace' +import { slug as slugAnchor } from "github-slugger" +import { trace } from "./trace" // Quartz Paths // Things in boxes are not actual types but rather sources which these types can be acquired from @@ -46,7 +46,7 @@ import { trace } from './trace' const STRICT_TYPE_CHECKS = false const HARD_EXIT_ON_FAIL = false -function conditionCheck(name: string, label: 'pre' | 'post', s: T, chk: (x: any) => x is T) { +function conditionCheck(name: string, label: "pre" | "post", s: T, chk: (x: any) => x is T) { if (STRICT_TYPE_CHECKS && !chk(s)) { trace(`${name} failed ${label}-condition check: ${s} does not pass ${chk.name}`, new Error()) if (HARD_EXIT_ON_FAIL) { @@ -66,8 +66,8 @@ export function isClientSlug(s: string): s is ClientSlug { } /** Canonical slug, should be used whenever you need to refer to the location of a file/note. - * On the client, this is normally stored in `document.body.dataset.slug` - */ + * On the client, this is normally stored in `document.body.dataset.slug` + */ export type CanonicalSlug = SlugLike<"canonical"> export function isCanonicalSlug(s: string): s is CanonicalSlug { const validStart = !(s.startsWith(".") || s.startsWith("/")) @@ -76,8 +76,8 @@ export function isCanonicalSlug(s: string): s is CanonicalSlug { } /** A relative link, can be found on `href`s but can also be constructed for - * client-side navigation (e.g. search and graph) - */ + * client-side navigation (e.g. search and graph) + */ export type RelativeURL = SlugLike<"relative"> export function isRelativeURL(s: string): s is RelativeURL { const validStart = /^\.{1,2}/.test(s) @@ -102,58 +102,58 @@ export function isFilePath(s: string): s is FilePath { export function getClientSlug(window: Window): ClientSlug { const res = window.location.href as ClientSlug - conditionCheck(getClientSlug.name, 'post', res, isClientSlug) + conditionCheck(getClientSlug.name, "post", res, isClientSlug) return res } export function getCanonicalSlug(window: Window): CanonicalSlug { const res = window.document.body.dataset.slug! as CanonicalSlug - conditionCheck(getCanonicalSlug.name, 'post', res, isCanonicalSlug) + conditionCheck(getCanonicalSlug.name, "post", res, isCanonicalSlug) return res } export function canonicalizeClient(slug: ClientSlug): CanonicalSlug { - conditionCheck(canonicalizeClient.name, 'pre', slug, isClientSlug) + conditionCheck(canonicalizeClient.name, "pre", slug, isClientSlug) const { pathname } = new URL(slug) let fp = pathname.slice(1) - fp = fp.replace(new RegExp(_getFileExtension(fp) + '$'), '') + fp = fp.replace(new RegExp(_getFileExtension(fp) + "$"), "") const res = _canonicalize(fp) as CanonicalSlug - conditionCheck(canonicalizeClient.name, 'post', res, isCanonicalSlug) + conditionCheck(canonicalizeClient.name, "post", res, isCanonicalSlug) return res } export function canonicalizeServer(slug: ServerSlug): CanonicalSlug { - conditionCheck(canonicalizeServer.name, 'pre', slug, isServerSlug) + conditionCheck(canonicalizeServer.name, "pre", slug, isServerSlug) let fp = slug as string const res = _canonicalize(fp) as CanonicalSlug - conditionCheck(canonicalizeServer.name, 'post', res, isCanonicalSlug) + conditionCheck(canonicalizeServer.name, "post", res, isCanonicalSlug) return res } export function slugifyFilePath(fp: FilePath): ServerSlug { - conditionCheck(slugifyFilePath.name, 'pre', fp, isFilePath) + conditionCheck(slugifyFilePath.name, "pre", fp, isFilePath) fp = _stripSlashes(fp) as FilePath - const withoutFileExt = fp.replace(new RegExp(_getFileExtension(fp) + '$'), '') + const withoutFileExt = fp.replace(new RegExp(_getFileExtension(fp) + "$"), "") let slug = withoutFileExt - .split('/') - .map((segment) => segment.replace(/\s/g, '-')) // slugify all segments - .join('/') // always use / as sep - .replace(/\/$/, '') // remove trailing slash + .split("/") + .map((segment) => segment.replace(/\s/g, "-")) // slugify all segments + .join("/") // always use / as sep + .replace(/\/$/, "") // remove trailing slash // treat _index as index if (_endsWith(slug, "_index")) { slug = slug.replace(/_index$/, "index") } - conditionCheck(slugifyFilePath.name, 'post', slug, isServerSlug) + conditionCheck(slugifyFilePath.name, "post", slug, isServerSlug) return slug as ServerSlug } export function transformInternalLink(link: string): RelativeURL { let [fplike, anchor] = splitAnchor(decodeURI(link)) - let segments = fplike.split("/").filter(x => x.length > 0) + let segments = fplike.split("/").filter((x) => x.length > 0) let prefix = segments.filter(_isRelativeSegment).join("/") - let fp = segments.filter(seg => !_isRelativeSegment(seg)).join("/") + let fp = segments.filter((seg) => !_isRelativeSegment(seg)).join("/") // implicit markdown if (!_hasFileExtension(fp)) { @@ -164,57 +164,57 @@ export function transformInternalLink(link: string): RelativeURL { fp = _trimSuffix(fp, "index") let joined = joinSegments(_stripSlashes(prefix), _stripSlashes(fp)) - const res = _addRelativeToStart(joined) + anchor as RelativeURL - conditionCheck(transformInternalLink.name, 'post', res, isRelativeURL) + const res = (_addRelativeToStart(joined) + anchor) as RelativeURL + conditionCheck(transformInternalLink.name, "post", res, isRelativeURL) return res } // resolve /a/b/c to ../../ export function pathToRoot(slug: CanonicalSlug): RelativeURL { - conditionCheck(pathToRoot.name, 'pre', slug, isCanonicalSlug) + conditionCheck(pathToRoot.name, "pre", slug, isCanonicalSlug) let rootPath = slug - .split('/') - .filter(x => x !== '') - .map(_ => '..') - .join('/') + .split("/") + .filter((x) => x !== "") + .map((_) => "..") + .join("/") const res = _addRelativeToStart(rootPath) as RelativeURL - conditionCheck(pathToRoot.name, 'post', res, isRelativeURL) + conditionCheck(pathToRoot.name, "post", res, isRelativeURL) return res } export function resolveRelative(current: CanonicalSlug, target: CanonicalSlug): RelativeURL { - conditionCheck(resolveRelative.name, 'pre', current, isCanonicalSlug) - conditionCheck(resolveRelative.name, 'pre', target, isCanonicalSlug) + conditionCheck(resolveRelative.name, "pre", current, isCanonicalSlug) + conditionCheck(resolveRelative.name, "pre", target, isCanonicalSlug) const res = joinSegments(pathToRoot(current), target) as RelativeURL - conditionCheck(resolveRelative.name, 'post', res, isRelativeURL) + conditionCheck(resolveRelative.name, "post", res, isRelativeURL) return res } export function splitAnchor(link: string): [string, string] { let [fp, anchor] = link.split("#", 2) - anchor = anchor === undefined ? "" : '#' + slugAnchor(anchor) + anchor = anchor === undefined ? "" : "#" + slugAnchor(anchor) return [fp, anchor] } export function joinSegments(...args: string[]): string { - return args.filter(segment => segment !== "").join('/') + return args.filter((segment) => segment !== "").join("/") } export const QUARTZ = "quartz" function _canonicalize(fp: string): string { fp = _trimSuffix(fp, "index") - return _stripSlashes(fp) + return _stripSlashes(fp) } function _endsWith(s: string, suffix: string): boolean { - return s === suffix || s.endsWith("/" + suffix) + return s === suffix || s.endsWith("/" + suffix) } function _trimSuffix(s: string, suffix: string): string { if (_endsWith(s, suffix)) { - s = s.slice(0, -(suffix.length)) + s = s.slice(0, -suffix.length) } return s } diff --git a/quartz/perf.ts b/quartz/perf.ts index cb047aac..ba34ddb6 100644 --- a/quartz/perf.ts +++ b/quartz/perf.ts @@ -1,12 +1,12 @@ -import chalk from 'chalk' -import pretty from 'pretty-time' +import chalk from "chalk" +import pretty from "pretty-time" export class PerfTimer { evts: { [key: string]: [number, number] } constructor() { this.evts = {} - this.addEvent('start') + this.addEvent("start") } addEvent(evtName: string) { @@ -14,6 +14,6 @@ export class PerfTimer { } timeSince(evtName?: string): string { - return chalk.yellow(pretty(process.hrtime(this.evts[evtName ?? 'start']))) + return chalk.yellow(pretty(process.hrtime(this.evts[evtName ?? "start"]))) } } diff --git a/quartz/plugins/emitters/aliases.ts b/quartz/plugins/emitters/aliases.ts index 84ace744..2350cb70 100644 --- a/quartz/plugins/emitters/aliases.ts +++ b/quartz/plugins/emitters/aliases.ts @@ -1,6 +1,12 @@ -import { CanonicalSlug, FilePath, ServerSlug, canonicalizeServer, resolveRelative } from "../../path" +import { + CanonicalSlug, + FilePath, + ServerSlug, + canonicalizeServer, + resolveRelative, +} from "../../path" import { QuartzEmitterPlugin } from "../types" -import path from 'path' +import path from "path" export const AliasRedirects: QuartzEmitterPlugin = () => ({ name: "AliasRedirects", @@ -24,7 +30,7 @@ export const AliasRedirects: QuartzEmitterPlugin = () => ({ for (const alias of aliases) { const slug = path.posix.join(dir, alias) as ServerSlug - const fp = slug + ".html" as FilePath + const fp = (slug + ".html") as FilePath const redirUrl = resolveRelative(canonicalizeServer(slug), ogSlug) await emit({ content: ` @@ -47,5 +53,5 @@ export const AliasRedirects: QuartzEmitterPlugin = () => ({ } } return fps - } + }, }) diff --git a/quartz/plugins/emitters/contentIndex.ts b/quartz/plugins/emitters/contentIndex.ts index c9ad0a4b..0b1fec79 100644 --- a/quartz/plugins/emitters/contentIndex.ts +++ b/quartz/plugins/emitters/contentIndex.ts @@ -5,12 +5,12 @@ import path from "path" export type ContentIndex = Map export type ContentDetails = { - title: string, - links: CanonicalSlug[], - tags: string[], - content: string, - date?: Date, - description?: string, + title: string + links: CanonicalSlug[] + tags: string[] + content: string + date?: Date + description?: string } interface Options { @@ -31,7 +31,9 @@ function generateSiteMap(cfg: GlobalConfiguration, idx: ContentIndex): string { https://${base}/${slug} ${content.date?.toISOString()} ` - const urls = Array.from(idx).map(([slug, content]) => createURLEntry(slug, content)).join("") + const urls = Array.from(idx) + .map(([slug, content]) => createURLEntry(slug, content)) + .join("") return `${urls}` } @@ -47,7 +49,9 @@ function generateRSSFeed(cfg: GlobalConfiguration, idx: ContentIndex): string { ${content.date?.toUTCString()} ` - const items = Array.from(idx).map(([slug, content]) => createURLEntry(slug, content)).join("") + const items = Array.from(idx) + .map(([slug, content]) => createURLEntry(slug, content)) + .join("") return ` ${cfg.pageTitle} @@ -71,14 +75,14 @@ export const ContentIndex: QuartzEmitterPlugin> = (opts) => { const slug = canonicalizeServer(file.data.slug!) const date = file.data.dates?.modified ?? new Date() if (opts?.includeEmptyFiles || (file.data.text && file.data.text !== "")) { - linkIndex.set(slug, { - title: file.data.frontmatter?.title!, - links: file.data.links ?? [], - tags: file.data.frontmatter?.tags ?? [], - content: file.data.text ?? "", - date: date, - description: file.data.description ?? "" - }) + linkIndex.set(slug, { + title: file.data.frontmatter?.title!, + links: file.data.links ?? [], + tags: file.data.frontmatter?.tags ?? [], + content: file.data.text ?? "", + date: date, + description: file.data.description ?? "", + }) } } @@ -86,7 +90,7 @@ export const ContentIndex: QuartzEmitterPlugin> = (opts) => { await emit({ content: generateSiteMap(cfg, linkIndex), slug: "sitemap" as ServerSlug, - ext: ".xml" + ext: ".xml", }) emitted.push("sitemap.xml" as FilePath) } @@ -95,7 +99,7 @@ export const ContentIndex: QuartzEmitterPlugin> = (opts) => { await emit({ content: generateRSSFeed(cfg, linkIndex), slug: "index" as ServerSlug, - ext: ".xml" + ext: ".xml", }) emitted.push("index.xml" as FilePath) } @@ -109,7 +113,7 @@ export const ContentIndex: QuartzEmitterPlugin> = (opts) => { delete content.description delete content.date return [slug, content] - }) + }), ) await emit({ diff --git a/quartz/plugins/emitters/contentPage.tsx b/quartz/plugins/emitters/contentPage.tsx index 889cf600..59a24f23 100644 --- a/quartz/plugins/emitters/contentPage.tsx +++ b/quartz/plugins/emitters/contentPage.tsx @@ -8,7 +8,9 @@ import { FilePath, canonicalizeServer } from "../../path" export const ContentPage: QuartzEmitterPlugin = (opts) => { if (!opts) { - throw new Error("ContentPage must be initialized with options specifiying the components to use") + throw new Error( + "ContentPage must be initialized with options specifiying the components to use", + ) } const { head: Head, header, beforeBody, pageBody: Content, left, right, footer: Footer } = opts @@ -22,7 +24,7 @@ export const ContentPage: QuartzEmitterPlugin = (opts) => { }, async emit(_contentDir, cfg, content, resources, emit): Promise { const fps: FilePath[] = [] - const allFiles = content.map(c => c[1].data) + const allFiles = content.map((c) => c[1].data) for (const [tree, file] of content) { const slug = canonicalizeServer(file.data.slug!) const externalResources = pageResources(slug, resources) @@ -32,17 +34,12 @@ export const ContentPage: QuartzEmitterPlugin = (opts) => { cfg, children: [], tree, - allFiles + allFiles, } - const content = renderPage( - slug, - componentData, - opts, - externalResources - ) + const content = renderPage(slug, componentData, opts, externalResources) - const fp = file.data.slug + ".html" as FilePath + const fp = (file.data.slug + ".html") as FilePath await emit({ content, slug: file.data.slug!, @@ -52,6 +49,6 @@ export const ContentPage: QuartzEmitterPlugin = (opts) => { fps.push(fp) } return fps - } + }, } } diff --git a/quartz/plugins/emitters/folderPage.tsx b/quartz/plugins/emitters/folderPage.tsx index 2f6bcbf9..f58ac39f 100644 --- a/quartz/plugins/emitters/folderPage.tsx +++ b/quartz/plugins/emitters/folderPage.tsx @@ -24,20 +24,28 @@ export const FolderPage: QuartzEmitterPlugin = (opts) => { }, async emit(_contentDir, cfg, content, resources, emit): Promise { const fps: FilePath[] = [] - const allFiles = content.map(c => c[1].data) + const allFiles = content.map((c) => c[1].data) - const folders: Set = new Set(allFiles.flatMap(data => { - const slug = data.slug - const folderName = path.dirname(slug ?? "") as CanonicalSlug - if (slug && folderName !== "." && folderName !== "tags") { - return [folderName] - } - return [] - })) + const folders: Set = new Set( + allFiles.flatMap((data) => { + const slug = data.slug + const folderName = path.dirname(slug ?? "") as CanonicalSlug + if (slug && folderName !== "." && folderName !== "tags") { + return [folderName] + } + return [] + }), + ) - const folderDescriptions: Record = Object.fromEntries([...folders].map(folder => ([ - folder, defaultProcessedContent({ slug: joinSegments(folder, "index") as ServerSlug, frontmatter: { title: `Folder: ${folder}`, tags: [] } }) - ]))) + const folderDescriptions: Record = Object.fromEntries( + [...folders].map((folder) => [ + folder, + defaultProcessedContent({ + slug: joinSegments(folder, "index") as ServerSlug, + frontmatter: { title: `Folder: ${folder}`, tags: [] }, + }), + ]), + ) for (const [tree, file] of content) { const slug = canonicalizeServer(file.data.slug!) @@ -56,17 +64,12 @@ export const FolderPage: QuartzEmitterPlugin = (opts) => { cfg, children: [], tree, - allFiles + allFiles, } - const content = renderPage( - slug, - componentData, - opts, - externalResources - ) + const content = renderPage(slug, componentData, opts, externalResources) - const fp = file.data.slug! + ".html" as FilePath + const fp = (file.data.slug! + ".html") as FilePath await emit({ content, slug: file.data.slug!, @@ -76,6 +79,6 @@ export const FolderPage: QuartzEmitterPlugin = (opts) => { fps.push(fp) } return fps - } + }, } } diff --git a/quartz/plugins/emitters/index.ts b/quartz/plugins/emitters/index.ts index 435771d2..0017e823 100644 --- a/quartz/plugins/emitters/index.ts +++ b/quartz/plugins/emitters/index.ts @@ -1,5 +1,5 @@ -export { ContentPage } from './contentPage' -export { TagPage } from './tagPage' -export { FolderPage } from './folderPage' -export { ContentIndex } from './contentIndex' -export { AliasRedirects } from './aliases' +export { ContentPage } from "./contentPage" +export { TagPage } from "./tagPage" +export { FolderPage } from "./folderPage" +export { ContentIndex } from "./contentIndex" +export { AliasRedirects } from "./aliases" diff --git a/quartz/plugins/emitters/tagPage.tsx b/quartz/plugins/emitters/tagPage.tsx index 62bfe111..2903bb41 100644 --- a/quartz/plugins/emitters/tagPage.tsx +++ b/quartz/plugins/emitters/tagPage.tsx @@ -23,12 +23,18 @@ export const TagPage: QuartzEmitterPlugin = (opts) => { }, async emit(_contentDir, cfg, content, resources, emit): Promise { const fps: FilePath[] = [] - const allFiles = content.map(c => c[1].data) + const allFiles = content.map((c) => c[1].data) - const tags: Set = new Set(allFiles.flatMap(data => data.frontmatter?.tags ?? [])) - const tagDescriptions: Record = Object.fromEntries([...tags].map(tag => ([ - tag, defaultProcessedContent({ slug: `tags/${tag}/index` as ServerSlug, frontmatter: { title: `Tag: ${tag}`, tags: [] } }) - ]))) + const tags: Set = new Set(allFiles.flatMap((data) => data.frontmatter?.tags ?? [])) + const tagDescriptions: Record = Object.fromEntries( + [...tags].map((tag) => [ + tag, + defaultProcessedContent({ + slug: `tags/${tag}/index` as ServerSlug, + frontmatter: { title: `Tag: ${tag}`, tags: [] }, + }), + ]), + ) for (const [tree, file] of content) { const slug = file.data.slug! @@ -50,17 +56,12 @@ export const TagPage: QuartzEmitterPlugin = (opts) => { cfg, children: [], tree, - allFiles + allFiles, } - const content = renderPage( - slug, - componentData, - opts, - externalResources - ) + const content = renderPage(slug, componentData, opts, externalResources) - const fp = file.data.slug + ".html" as FilePath + const fp = (file.data.slug + ".html") as FilePath await emit({ content, slug: file.data.slug!, @@ -70,6 +71,6 @@ export const TagPage: QuartzEmitterPlugin = (opts) => { fps.push(fp) } return fps - } + }, } } diff --git a/quartz/plugins/filters/draft.ts b/quartz/plugins/filters/draft.ts index 630033d6..e4a1f8f7 100644 --- a/quartz/plugins/filters/draft.ts +++ b/quartz/plugins/filters/draft.ts @@ -5,5 +5,5 @@ export const RemoveDrafts: QuartzFilterPlugin<{}> = () => ({ shouldPublish([_tree, vfile]) { const draftFlag: boolean = vfile.data?.frontmatter?.draft ?? false return !draftFlag - } + }, }) diff --git a/quartz/plugins/filters/explicit.ts b/quartz/plugins/filters/explicit.ts index da5125b8..e0395a49 100644 --- a/quartz/plugins/filters/explicit.ts +++ b/quartz/plugins/filters/explicit.ts @@ -5,5 +5,5 @@ export const ExplicitPublish: QuartzFilterPlugin = () => ({ shouldPublish([_tree, vfile]) { const publishFlag: boolean = vfile.data?.frontmatter?.publish ?? false return publishFlag - } + }, }) diff --git a/quartz/plugins/filters/index.ts b/quartz/plugins/filters/index.ts index 1952c6f2..d9371434 100644 --- a/quartz/plugins/filters/index.ts +++ b/quartz/plugins/filters/index.ts @@ -1,2 +1,2 @@ -export { RemoveDrafts } from './draft' -export { ExplicitPublish } from './explicit' +export { RemoveDrafts } from "./draft" +export { ExplicitPublish } from "./explicit" diff --git a/quartz/plugins/index.ts b/quartz/plugins/index.ts index 5aed2078..a6231dbd 100644 --- a/quartz/plugins/index.ts +++ b/quartz/plugins/index.ts @@ -1,14 +1,14 @@ -import { GlobalConfiguration } from '../cfg' -import { QuartzComponent } from '../components/types' -import { StaticResources } from '../resources' -import { joinStyles } from '../theme' -import { EmitCallback, PluginTypes } from './types' -import styles from '../styles/base.scss' -import { FilePath, ServerSlug } from '../path' +import { GlobalConfiguration } from "../cfg" +import { QuartzComponent } from "../components/types" +import { StaticResources } from "../resources" +import { joinStyles } from "../theme" +import { EmitCallback, PluginTypes } from "./types" +import styles from "../styles/base.scss" +import { FilePath, ServerSlug } from "../path" export type ComponentResources = { - css: string[], - beforeDOMLoaded: string[], + css: string[] + beforeDOMLoaded: string[] afterDOMLoaded: string[] } @@ -24,7 +24,7 @@ export function getComponentResources(plugins: PluginTypes): ComponentResources const componentResources = { css: new Set(), beforeDOMLoaded: new Set(), - afterDOMLoaded: new Set() + afterDOMLoaded: new Set(), } for (const component of allComponents) { @@ -39,39 +39,42 @@ export function getComponentResources(plugins: PluginTypes): ComponentResources componentResources.afterDOMLoaded.add(afterDOMLoaded) } } - + return { css: [...componentResources.css], beforeDOMLoaded: [...componentResources.beforeDOMLoaded], - afterDOMLoaded: [...componentResources.afterDOMLoaded] + afterDOMLoaded: [...componentResources.afterDOMLoaded], } } function joinScripts(scripts: string[]): string { // wrap with iife to prevent scope collision - return scripts.map(script => `(function () {${script}})();`).join("\n") + return scripts.map((script) => `(function () {${script}})();`).join("\n") } -export async function emitComponentResources(cfg: GlobalConfiguration, res: ComponentResources, emit: EmitCallback): Promise { +export async function emitComponentResources( + cfg: GlobalConfiguration, + res: ComponentResources, + emit: EmitCallback, +): Promise { const fps = await Promise.all([ emit({ slug: "index" as ServerSlug, ext: ".css", - content: joinStyles(cfg.theme, styles, ...res.css) + content: joinStyles(cfg.theme, styles, ...res.css), }), emit({ slug: "prescript" as ServerSlug, ext: ".js", - content: joinScripts(res.beforeDOMLoaded) + content: joinScripts(res.beforeDOMLoaded), }), emit({ slug: "postscript" as ServerSlug, ext: ".js", - content: joinScripts(res.afterDOMLoaded) - }) + content: joinScripts(res.afterDOMLoaded), + }), ]) return fps - } export function getStaticResourcesFromPlugins(plugins: PluginTypes) { @@ -93,11 +96,11 @@ export function getStaticResourcesFromPlugins(plugins: PluginTypes) { return staticResources } -export * from './transformers' -export * from './filters' -export * from './emitters' +export * from "./transformers" +export * from "./filters" +export * from "./emitters" -declare module 'vfile' { +declare module "vfile" { // inserted in processors.ts interface DataMap { slug: ServerSlug diff --git a/quartz/plugins/transformers/description.ts b/quartz/plugins/transformers/description.ts index 3505b19b..08af5c78 100644 --- a/quartz/plugins/transformers/description.ts +++ b/quartz/plugins/transformers/description.ts @@ -1,4 +1,4 @@ -import { Root as HTMLRoot } from 'hast' +import { Root as HTMLRoot } from "hast" import { toString } from "hast-util-to-string" import { QuartzTransformerPlugin } from "../types" @@ -7,11 +7,16 @@ export interface Options { } const defaultOptions: Options = { - descriptionLength: 150 + descriptionLength: 150, } const escapeHTML = (unsafe: string) => { - return unsafe.replaceAll('&', '&').replaceAll('<', '<').replaceAll('>', '>').replaceAll('"', '"').replaceAll("'", '''); + return unsafe + .replaceAll("&", "&") + .replaceAll("<", "<") + .replaceAll(">", ">") + .replaceAll('"', """) + .replaceAll("'", "'") } export const Description: QuartzTransformerPlugin | undefined> = (userOpts) => { @@ -26,30 +31,29 @@ export const Description: QuartzTransformerPlugin | undefined> const text = escapeHTML(toString(tree)) const desc = frontMatterDescription ?? text - const sentences = desc.replace(/\s+/g, ' ').split('.') + const sentences = desc.replace(/\s+/g, " ").split(".") let finalDesc = "" let sentenceIdx = 0 const len = opts.descriptionLength while (finalDesc.length < len) { const sentence = sentences[sentenceIdx] if (!sentence) break - finalDesc += sentence + '.' + finalDesc += sentence + "." sentenceIdx++ } file.data.description = finalDesc file.data.text = text } - } + }, ] - } + }, } } -declare module 'vfile' { +declare module "vfile" { interface DataMap { description: string text: string } } - diff --git a/quartz/plugins/transformers/frontmatter.ts b/quartz/plugins/transformers/frontmatter.ts index e9432a1d..29b0b4b5 100644 --- a/quartz/plugins/transformers/frontmatter.ts +++ b/quartz/plugins/transformers/frontmatter.ts @@ -1,17 +1,17 @@ import matter from "gray-matter" -import remarkFrontmatter from 'remark-frontmatter' +import remarkFrontmatter from "remark-frontmatter" import { QuartzTransformerPlugin } from "../types" -import yaml from 'js-yaml' -import { slug as slugAnchor } from 'github-slugger' +import yaml from "js-yaml" +import { slug as slugAnchor } from "github-slugger" export interface Options { - language: 'yaml' | 'toml', + language: "yaml" | "toml" delims: string | string[] } const defaultOptions: Options = { - language: 'yaml', - delims: '---' + language: "yaml", + delims: "---", } export const FrontMatter: QuartzTransformerPlugin | undefined> = (userOpts) => { @@ -26,8 +26,8 @@ export const FrontMatter: QuartzTransformerPlugin | undefined> const { data } = matter(file.value, { ...opts, engines: { - yaml: s => yaml.load(s, { schema: yaml.JSON_SCHEMA }) as object - } + yaml: (s) => yaml.load(s, { schema: yaml.JSON_SCHEMA }) as object, + }, }) // tag is an alias for tags @@ -36,7 +36,10 @@ export const FrontMatter: QuartzTransformerPlugin | undefined> } if (data.tags && !Array.isArray(data.tags)) { - data.tags = data.tags.toString().split(",").map((tag: string) => tag.trim()) + data.tags = data.tags + .toString() + .split(",") + .map((tag: string) => tag.trim()) } // slug them all!! @@ -46,16 +49,16 @@ export const FrontMatter: QuartzTransformerPlugin | undefined> file.data.frontmatter = { title: file.stem ?? "Untitled", tags: [], - ...data + ...data, } } - } + }, ] }, } } -declare module 'vfile' { +declare module "vfile" { interface DataMap { frontmatter: { [key: string]: any } & { title: string diff --git a/quartz/plugins/transformers/gfm.ts b/quartz/plugins/transformers/gfm.ts index f966e58b..62624aac 100644 --- a/quartz/plugins/transformers/gfm.ts +++ b/quartz/plugins/transformers/gfm.ts @@ -1,5 +1,5 @@ import remarkGfm from "remark-gfm" -import smartypants from 'remark-smartypants' +import smartypants from "remark-smartypants" import { QuartzTransformerPlugin } from "../types" import rehypeSlug from "rehype-slug" import rehypeAutolinkHeadings from "rehype-autolink-headings" @@ -11,10 +11,12 @@ export interface Options { const defaultOptions: Options = { enableSmartyPants: true, - linkHeadings: true + linkHeadings: true, } -export const GitHubFlavoredMarkdown: QuartzTransformerPlugin | undefined> = (userOpts) => { +export const GitHubFlavoredMarkdown: QuartzTransformerPlugin | undefined> = ( + userOpts, +) => { const opts = { ...defaultOptions, ...userOpts } return { name: "GitHubFlavoredMarkdown", @@ -23,15 +25,22 @@ export const GitHubFlavoredMarkdown: QuartzTransformerPlugin | }, htmlPlugins() { if (opts.linkHeadings) { - return [rehypeSlug, [rehypeAutolinkHeadings, { - behavior: 'append', content: { - type: 'text', - value: ' §', - } - }]] + return [ + rehypeSlug, + [ + rehypeAutolinkHeadings, + { + behavior: "append", + content: { + type: "text", + value: " §", + }, + }, + ], + ] } else { return [] } - } + }, } } diff --git a/quartz/plugins/transformers/index.ts b/quartz/plugins/transformers/index.ts index 2db74588..8013ab7c 100644 --- a/quartz/plugins/transformers/index.ts +++ b/quartz/plugins/transformers/index.ts @@ -1,9 +1,9 @@ -export { FrontMatter } from './frontmatter' -export { GitHubFlavoredMarkdown } from './gfm' -export { CreatedModifiedDate } from './lastmod' -export { Latex } from './latex' -export { Description } from './description' -export { CrawlLinks } from './links' -export { ObsidianFlavoredMarkdown } from './ofm' -export { SyntaxHighlighting } from './syntax' -export { TableOfContents } from './toc' +export { FrontMatter } from "./frontmatter" +export { GitHubFlavoredMarkdown } from "./gfm" +export { CreatedModifiedDate } from "./lastmod" +export { Latex } from "./latex" +export { Description } from "./description" +export { CrawlLinks } from "./links" +export { ObsidianFlavoredMarkdown } from "./ofm" +export { SyntaxHighlighting } from "./syntax" +export { TableOfContents } from "./toc" diff --git a/quartz/plugins/transformers/lastmod.ts b/quartz/plugins/transformers/lastmod.ts index 811fd476..ecdcc413 100644 --- a/quartz/plugins/transformers/lastmod.ts +++ b/quartz/plugins/transformers/lastmod.ts @@ -1,18 +1,20 @@ import fs from "fs" -import path from 'path' +import path from "path" import { Repository } from "@napi-rs/simple-git" import { QuartzTransformerPlugin } from "../types" export interface Options { - priority: ('frontmatter' | 'git' | 'filesystem')[], + priority: ("frontmatter" | "git" | "filesystem")[] } const defaultOptions: Options = { - priority: ['frontmatter', 'git', 'filesystem'] + priority: ["frontmatter", "git", "filesystem"], } type MaybeDate = undefined | string | number -export const CreatedModifiedDate: QuartzTransformerPlugin | undefined> = (userOpts) => { +export const CreatedModifiedDate: QuartzTransformerPlugin | undefined> = ( + userOpts, +) => { const opts = { ...defaultOptions, ...userOpts } return { name: "CreatedModifiedDate", @@ -51,13 +53,13 @@ export const CreatedModifiedDate: QuartzTransformerPlugin | und published: published ? new Date(published) : new Date(), } } - } + }, ] }, } } -declare module 'vfile' { +declare module "vfile" { interface DataMap { dates: { created: Date diff --git a/quartz/plugins/transformers/latex.ts b/quartz/plugins/transformers/latex.ts index 7feeda8a..7a98bde4 100644 --- a/quartz/plugins/transformers/latex.ts +++ b/quartz/plugins/transformers/latex.ts @@ -1,43 +1,39 @@ import remarkMath from "remark-math" -import rehypeKatex from 'rehype-katex' -import rehypeMathjax from 'rehype-mathjax/svg.js' +import rehypeKatex from "rehype-katex" +import rehypeMathjax from "rehype-mathjax/svg.js" import { QuartzTransformerPlugin } from "../types" interface Options { - renderEngine: 'katex' | 'mathjax' + renderEngine: "katex" | "mathjax" } export const Latex: QuartzTransformerPlugin = (opts?: Options) => { - const engine = opts?.renderEngine ?? 'katex' + const engine = opts?.renderEngine ?? "katex" return { name: "Latex", markdownPlugins() { return [remarkMath] }, htmlPlugins() { - return [ - engine === 'katex' - ? [rehypeKatex, { output: 'html' }] - : [rehypeMathjax] - ] + return [engine === "katex" ? [rehypeKatex, { output: "html" }] : [rehypeMathjax]] }, externalResources() { - return engine === 'katex' + return engine === "katex" ? { - css: [ - // base css - "https://cdn.jsdelivr.net/npm/katex@0.16.0/dist/katex.min.css", - ], - js: [ - { - // fix copy behaviour: https://github.com/KaTeX/KaTeX/blob/main/contrib/copy-tex/README.md - src: "https://cdn.jsdelivr.net/npm/katex@0.16.7/dist/contrib/copy-tex.min.js", - loadTime: "afterDOMReady", - contentType: 'external' - } - ] - } + css: [ + // base css + "https://cdn.jsdelivr.net/npm/katex@0.16.0/dist/katex.min.css", + ], + js: [ + { + // fix copy behaviour: https://github.com/KaTeX/KaTeX/blob/main/contrib/copy-tex/README.md + src: "https://cdn.jsdelivr.net/npm/katex@0.16.7/dist/contrib/copy-tex.min.js", + loadTime: "afterDOMReady", + contentType: "external", + }, + ], + } : {} - } + }, } } diff --git a/quartz/plugins/transformers/links.ts b/quartz/plugins/transformers/links.ts index da1c3433..96c5f589 100644 --- a/quartz/plugins/transformers/links.ts +++ b/quartz/plugins/transformers/links.ts @@ -1,18 +1,27 @@ import { QuartzTransformerPlugin } from "../types" -import { CanonicalSlug, RelativeURL, canonicalizeServer, joinSegments, pathToRoot, resolveRelative, splitAnchor, transformInternalLink } from "../../path" +import { + CanonicalSlug, + RelativeURL, + canonicalizeServer, + joinSegments, + pathToRoot, + resolveRelative, + splitAnchor, + transformInternalLink, +} from "../../path" import path from "path" -import { visit } from 'unist-util-visit' +import { visit } from "unist-util-visit" import isAbsoluteUrl from "is-absolute-url" interface Options { /** How to resolve Markdown paths */ - markdownLinkResolution: 'absolute' | 'relative' | 'shortest' + markdownLinkResolution: "absolute" | "relative" | "shortest" /** Strips folders from a link so that it looks nice */ prettyLinks: boolean } const defaultOptions: Options = { - markdownLinkResolution: 'absolute', + markdownLinkResolution: "absolute", prettyLinks: true, } @@ -21,84 +30,91 @@ export const CrawlLinks: QuartzTransformerPlugin | undefined> = return { name: "LinkProcessing", htmlPlugins() { - return [() => { - return (tree, file) => { - const curSlug = canonicalizeServer(file.data.slug!) - const transformLink = (target: string): RelativeURL => { - const targetSlug = transformInternalLink(target).slice("./".length) - let [targetCanonical, targetAnchor] = splitAnchor(targetSlug) - if (opts.markdownLinkResolution === 'relative') { - return targetSlug as RelativeURL - } else if (opts.markdownLinkResolution === 'shortest') { - // https://forum.obsidian.md/t/settings-new-link-format-what-is-shortest-path-when-possible/6748/5 - const allSlugs = file.data.allSlugs! + return [ + () => { + return (tree, file) => { + const curSlug = canonicalizeServer(file.data.slug!) + const transformLink = (target: string): RelativeURL => { + const targetSlug = transformInternalLink(target).slice("./".length) + let [targetCanonical, targetAnchor] = splitAnchor(targetSlug) + if (opts.markdownLinkResolution === "relative") { + return targetSlug as RelativeURL + } else if (opts.markdownLinkResolution === "shortest") { + // https://forum.obsidian.md/t/settings-new-link-format-what-is-shortest-path-when-possible/6748/5 + const allSlugs = file.data.allSlugs! - // if the file name is unique, then it's just the filename - const matchingFileNames = allSlugs.filter(slug => { - const parts = slug.split(path.posix.sep) - const fileName = parts.at(-1) - return targetCanonical === fileName - }) + // if the file name is unique, then it's just the filename + const matchingFileNames = allSlugs.filter((slug) => { + const parts = slug.split(path.posix.sep) + const fileName = parts.at(-1) + return targetCanonical === fileName + }) - if (matchingFileNames.length === 1) { - const targetSlug = canonicalizeServer(matchingFileNames[0]) - return resolveRelative(curSlug, targetSlug) + targetAnchor as RelativeURL + if (matchingFileNames.length === 1) { + const targetSlug = canonicalizeServer(matchingFileNames[0]) + return (resolveRelative(curSlug, targetSlug) + targetAnchor) as RelativeURL + } + + // if it's not unique, then it's the absolute path from the vault root + // (fall-through case) } - // if it's not unique, then it's the absolute path from the vault root - // (fall-through case) + // treat as absolute + return joinSegments(pathToRoot(curSlug), targetSlug) as RelativeURL } - // treat as absolute - return joinSegments(pathToRoot(curSlug), targetSlug) as RelativeURL + const outgoing: Set = new Set() + visit(tree, "element", (node, _index, _parent) => { + // rewrite all links + if ( + node.tagName === "a" && + node.properties && + typeof node.properties.href === "string" + ) { + let dest = node.properties.href as RelativeURL + node.properties.className = isAbsoluteUrl(dest) ? "external" : "internal" + + // don't process external links or intra-document anchors + if (!(isAbsoluteUrl(dest) || dest.startsWith("#"))) { + dest = node.properties.href = transformLink(dest) + const canonicalDest = path.normalize(joinSegments(curSlug, dest)) + const [destCanonical, _destAnchor] = splitAnchor(canonicalDest) + outgoing.add(destCanonical as CanonicalSlug) + } + + // rewrite link internals if prettylinks is on + if ( + opts.prettyLinks && + node.children.length === 1 && + node.children[0].type === "text" + ) { + node.children[0].value = path.basename(node.children[0].value) + } + } + + // transform all other resources that may use links + if ( + ["img", "video", "audio", "iframe"].includes(node.tagName) && + node.properties && + typeof node.properties.src === "string" + ) { + if (!isAbsoluteUrl(node.properties.src)) { + const ext = path.extname(node.properties.src) + node.properties.src = + transformLink(path.join("assets", node.properties.src)) + ext + } + } + }) + + file.data.links = [...outgoing] } - - const outgoing: Set = new Set() - visit(tree, 'element', (node, _index, _parent) => { - // rewrite all links - if ( - node.tagName === 'a' && - node.properties && - typeof node.properties.href === 'string' - ) { - let dest = node.properties.href as RelativeURL - node.properties.className = isAbsoluteUrl(dest) ? "external" : "internal" - - // don't process external links or intra-document anchors - if (!(isAbsoluteUrl(dest) || dest.startsWith("#"))) { - dest = node.properties.href = transformLink(dest) - const canonicalDest = path.normalize(joinSegments(curSlug, dest)) - const [destCanonical, _destAnchor] = splitAnchor(canonicalDest) - outgoing.add(destCanonical as CanonicalSlug) - } - - // rewrite link internals if prettylinks is on - if (opts.prettyLinks && node.children.length === 1 && node.children[0].type === 'text') { - node.children[0].value = path.basename(node.children[0].value) - } - } - - // transform all other resources that may use links - if ( - ["img", "video", "audio", "iframe"].includes(node.tagName) && - node.properties && - typeof node.properties.src === 'string' - ) { - if (!isAbsoluteUrl(node.properties.src)) { - const ext = path.extname(node.properties.src) - node.properties.src = transformLink(path.join("assets", node.properties.src)) + ext - } - } - }) - - file.data.links = [...outgoing] - } - }] - } + }, + ] + }, } } -declare module 'vfile' { +declare module "vfile" { interface DataMap { links: CanonicalSlug[] } diff --git a/quartz/plugins/transformers/ofm.ts b/quartz/plugins/transformers/ofm.ts index 41b38659..23b14019 100644 --- a/quartz/plugins/transformers/ofm.ts +++ b/quartz/plugins/transformers/ofm.ts @@ -1,8 +1,8 @@ import { PluggableList } from "unified" import { QuartzTransformerPlugin } from "../types" -import { Root, HTML, BlockContent, DefinitionContent, Code } from 'mdast' +import { Root, HTML, BlockContent, DefinitionContent, Code } from "mdast" import { findAndReplace } from "mdast-util-find-and-replace" -import { slug as slugAnchor } from 'github-slugger' +import { slug as slugAnchor } from "github-slugger" import rehypeRaw from "rehype-raw" import { visit } from "unist-util-visit" import path from "path" @@ -71,7 +71,7 @@ function canonicalizeCallout(calloutName: string): keyof typeof callouts { bug: "bug", example: "example", quote: "quote", - cite: "quote" + cite: "quote", } return calloutMapping[callout] @@ -94,10 +94,10 @@ const callouts = { } const capitalize = (s: string): string => { - return s.substring(0, 1).toUpperCase() + s.substring(1); + return s.substring(0, 1).toUpperCase() + s.substring(1) } -// Match wikilinks +// Match wikilinks // !? -> optional embedding // \[\[ -> open brace // ([^\[\]\|\#]+) -> one or more non-special characters ([,],|, or #) (name) @@ -105,16 +105,18 @@ const capitalize = (s: string): string => { // (|[^\[\]\|\#]+)? -> | then one or more non-special characters (alias) const wikilinkRegex = new RegExp(/!?\[\[([^\[\]\|\#]+)(#[^\[\]\|\#]+)?(\|[^\[\]\|\#]+)?\]\]/, "g") -// Match highlights +// Match highlights const highlightRegex = new RegExp(/==(.+)==/, "g") -// Match comments +// Match comments const commentRegex = new RegExp(/%%(.+)%%/, "g") // from https://github.com/escwxyz/remark-obsidian-callout/blob/main/src/index.ts const calloutRegex = new RegExp(/^\[\!(\w+)\]([+-]?)/) -export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin | undefined> = (userOpts) => { +export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin | undefined> = ( + userOpts, +) => { const opts = { ...defaultOptions, ...userOpts } return { name: "ObsidianFlavoredMarkdown", @@ -154,28 +156,31 @@ export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin width ||= "auto" height ||= "auto" return { - type: 'image', + type: "image", url, data: { hProperties: { - width, height - } - } + width, + height, + }, + }, } } else if ([".mp4", ".webm", ".ogv", ".mov", ".mkv"].includes(ext)) { return { - type: 'html', - value: `` + type: "html", + value: ``, } - } else if ([".mp3", ".webm", ".wav", ".m4a", ".ogg", ".3gp", ".flac"].includes(ext)) { + } else if ( + [".mp3", ".webm", ".wav", ".m4a", ".ogg", ".3gp", ".flac"].includes(ext) + ) { return { - type: 'html', - value: `` + type: "html", + value: ``, } } else if ([".pdf"].includes(ext)) { return { - type: 'html', - value: `` + type: "html", + value: ``, } } else { // TODO: this is the node embed case @@ -187,17 +192,18 @@ export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin // const url = transformInternalLink(fp + anchor) const url = fp + anchor return { - type: 'link', + type: "link", url, - children: [{ - type: 'text', - value: alias ?? fp - }] + children: [ + { + type: "text", + value: alias ?? fp, + }, + ], } }) } - } - ) + }) } if (opts.highlight) { @@ -206,21 +212,21 @@ export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin findAndReplace(tree, highlightRegex, (_value: string, ...capture: string[]) => { const [inner] = capture return { - type: 'html', - value: `${inner}` + type: "html", + value: `${inner}`, } }) } }) } - + if (opts.comments) { plugins.push(() => { return (tree: Root, _file) => { findAndReplace(tree, commentRegex, (_value: string, ..._capture: string[]) => { return { - type: 'text', - value: '' + type: "text", + value: "", } }) } @@ -252,7 +258,8 @@ export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin const calloutType = typeString.toLowerCase() as keyof typeof callouts const collapse = collapseChar === "+" || collapseChar === "-" const defaultState = collapseChar === "-" ? "collapsed" : "expanded" - const title = match.input.slice(calloutDirective.length).trim() || capitalize(calloutType) + const title = + match.input.slice(calloutDirective.length).trim() || capitalize(calloutType) const toggleIcon = ` @@ -266,17 +273,20 @@ export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin
${callouts[canonicalizeCallout(calloutType)]}
${title}
${collapse ? toggleIcon : ""} -
` +
`, } const blockquoteContent: (BlockContent | DefinitionContent)[] = [titleNode] if (remainingText.length > 0) { blockquoteContent.push({ - type: 'paragraph', - children: [{ - type: 'text', - value: remainingText, - }, ...restChildren] + type: "paragraph", + children: [ + { + type: "text", + value: remainingText, + }, + ...restChildren, + ], }) } @@ -287,10 +297,12 @@ export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin node.data = { hProperties: { ...(node.data?.hProperties ?? {}), - className: `callout ${collapse ? "is-collapsible" : ""} ${defaultState === "collapsed" ? "is-collapsed" : ""}`, + className: `callout ${collapse ? "is-collapsible" : ""} ${ + defaultState === "collapsed" ? "is-collapsed" : "" + }`, "data-callout": calloutType, "data-callout-fold": collapse, - } + }, } } }) @@ -301,12 +313,12 @@ export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin if (opts.mermaid) { plugins.push(() => { return (tree: Root, _file) => { - visit(tree, 'code', (node: Code) => { - if (node.lang === 'mermaid') { + visit(tree, "code", (node: Code) => { + if (node.lang === "mermaid") { node.data = { hProperties: { - className: 'mermaid' - } + className: "mermaid", + }, } } }) @@ -325,8 +337,8 @@ export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin if (opts.callouts) { js.push({ script: calloutScript, - loadTime: 'afterDOMReady', - contentType: 'inline' + loadTime: "afterDOMReady", + contentType: "inline", }) } @@ -336,13 +348,13 @@ export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.esm.min.mjs'; mermaid.initialize({ startOnLoad: true }); `, - loadTime: 'afterDOMReady', - moduleType: 'module', - contentType: 'inline' + loadTime: "afterDOMReady", + moduleType: "module", + contentType: "inline", }) } return { js } - } + }, } } diff --git a/quartz/plugins/transformers/syntax.ts b/quartz/plugins/transformers/syntax.ts index d2d0103b..17668174 100644 --- a/quartz/plugins/transformers/syntax.ts +++ b/quartz/plugins/transformers/syntax.ts @@ -4,8 +4,13 @@ import rehypePrettyCode, { Options as CodeOptions } from "rehype-pretty-code" export const SyntaxHighlighting: QuartzTransformerPlugin = () => ({ name: "SyntaxHighlighting", htmlPlugins() { - return [[rehypePrettyCode, { - theme: 'css-variables', - } satisfies Partial]] - } + return [ + [ + rehypePrettyCode, + { + theme: "css-variables", + } satisfies Partial, + ], + ] + }, }) diff --git a/quartz/plugins/transformers/toc.ts b/quartz/plugins/transformers/toc.ts index 01e0c8d2..87031a9d 100644 --- a/quartz/plugins/transformers/toc.ts +++ b/quartz/plugins/transformers/toc.ts @@ -2,11 +2,11 @@ import { QuartzTransformerPlugin } from "../types" import { Root } from "mdast" import { visit } from "unist-util-visit" import { toString } from "mdast-util-to-string" -import { slug as slugAnchor } from 'github-slugger' +import { slug as slugAnchor } from "github-slugger" export interface Options { - maxDepth: 1 | 2 | 3 | 4 | 5 | 6, - minEntries: 1, + maxDepth: 1 | 2 | 3 | 4 | 5 | 6 + minEntries: 1 showByDefault: boolean } @@ -17,47 +17,53 @@ const defaultOptions: Options = { } interface TocEntry { - depth: number, - text: string, + depth: number + text: string slug: string // this is just the anchor (#some-slug), not the canonical slug } -export const TableOfContents: QuartzTransformerPlugin | undefined> = (userOpts) => { +export const TableOfContents: QuartzTransformerPlugin | undefined> = ( + userOpts, +) => { const opts = { ...defaultOptions, ...userOpts } return { name: "TableOfContents", markdownPlugins() { - return [() => { - return async (tree: Root, file) => { - const display = file.data.frontmatter?.enableToc ?? opts.showByDefault - if (display) { - const toc: TocEntry[] = [] - let highestDepth: number = opts.maxDepth - visit(tree, 'heading', (node) => { - if (node.depth <= opts.maxDepth) { - const text = toString(node) - highestDepth = Math.min(highestDepth, node.depth) - toc.push({ - depth: node.depth, - text, - slug: slugAnchor(text) - }) - } - }) + return [ + () => { + return async (tree: Root, file) => { + const display = file.data.frontmatter?.enableToc ?? opts.showByDefault + if (display) { + const toc: TocEntry[] = [] + let highestDepth: number = opts.maxDepth + visit(tree, "heading", (node) => { + if (node.depth <= opts.maxDepth) { + const text = toString(node) + highestDepth = Math.min(highestDepth, node.depth) + toc.push({ + depth: node.depth, + text, + slug: slugAnchor(text), + }) + } + }) - if (toc.length > opts.minEntries) { - file.data.toc = toc.map(entry => ({ ...entry, depth: entry.depth - highestDepth })) + if (toc.length > opts.minEntries) { + file.data.toc = toc.map((entry) => ({ + ...entry, + depth: entry.depth - highestDepth, + })) + } } } - } - }] + }, + ] }, } } -declare module 'vfile' { +declare module "vfile" { interface DataMap { toc: TocEntry[] } } - diff --git a/quartz/plugins/types.ts b/quartz/plugins/types.ts index 8c0d182b..52dd833c 100644 --- a/quartz/plugins/types.ts +++ b/quartz/plugins/types.ts @@ -6,13 +6,15 @@ import { QuartzComponent } from "../components/types" import { FilePath, ServerSlug } from "../path" export interface PluginTypes { - transformers: QuartzTransformerPluginInstance[], - filters: QuartzFilterPluginInstance[], - emitters: QuartzEmitterPluginInstance[], + transformers: QuartzTransformerPluginInstance[] + filters: QuartzFilterPluginInstance[] + emitters: QuartzEmitterPluginInstance[] } type OptionType = object | undefined -export type QuartzTransformerPlugin = (opts?: Options) => QuartzTransformerPluginInstance +export type QuartzTransformerPlugin = ( + opts?: Options, +) => QuartzTransformerPluginInstance export type QuartzTransformerPluginInstance = { name: string textTransform?: (src: string | Buffer) => string | Buffer @@ -21,16 +23,26 @@ export type QuartzTransformerPluginInstance = { externalResources?: () => Partial } -export type QuartzFilterPlugin = (opts?: Options) => QuartzFilterPluginInstance +export type QuartzFilterPlugin = ( + opts?: Options, +) => QuartzFilterPluginInstance export type QuartzFilterPluginInstance = { name: string shouldPublish(content: ProcessedContent): boolean } -export type QuartzEmitterPlugin = (opts?: Options) => QuartzEmitterPluginInstance +export type QuartzEmitterPlugin = ( + opts?: Options, +) => QuartzEmitterPluginInstance export type QuartzEmitterPluginInstance = { name: string - emit(contentDir: string, cfg: GlobalConfiguration, content: ProcessedContent[], resources: StaticResources, emitCallback: EmitCallback): Promise + emit( + contentDir: string, + cfg: GlobalConfiguration, + content: ProcessedContent[], + resources: StaticResources, + emitCallback: EmitCallback, + ): Promise getQuartzComponents(): QuartzComponent[] } diff --git a/quartz/plugins/vfile.ts b/quartz/plugins/vfile.ts index d3d24d37..068981af 100644 --- a/quartz/plugins/vfile.ts +++ b/quartz/plugins/vfile.ts @@ -1,11 +1,11 @@ -import { Node, Parent } from 'hast' -import { Data, VFile } from 'vfile' +import { Node, Parent } from "hast" +import { Data, VFile } from "vfile" export type QuartzPluginData = Data export type ProcessedContent = [Node, VFile] export function defaultProcessedContent(vfileData: Partial): ProcessedContent { - const root: Parent = { type: 'root', children: [] } + const root: Parent = { type: "root", children: [] } const vfile = new VFile("") vfile.data = vfileData return [root, vfile] diff --git a/quartz/processors/emit.ts b/quartz/processors/emit.ts index 2b9fe929..d0567326 100644 --- a/quartz/processors/emit.ts +++ b/quartz/processors/emit.ts @@ -2,25 +2,35 @@ import path from "path" import fs from "fs" import { GlobalConfiguration, QuartzConfig } from "../cfg" import { PerfTimer } from "../perf" -import { ComponentResources, emitComponentResources, getComponentResources, getStaticResourcesFromPlugins } from "../plugins" +import { + ComponentResources, + emitComponentResources, + getComponentResources, + getStaticResourcesFromPlugins, +} from "../plugins" import { EmitCallback } from "../plugins/types" import { ProcessedContent } from "../plugins/vfile" import { FilePath, QUARTZ, slugifyFilePath } from "../path" import { globbyStream } from "globby" // @ts-ignore -import spaRouterScript from '../components/scripts/spa.inline' +import spaRouterScript from "../components/scripts/spa.inline" // @ts-ignore -import plausibleScript from '../components/scripts/plausible.inline' +import plausibleScript from "../components/scripts/plausible.inline" // @ts-ignore -import popoverScript from '../components/scripts/popover.inline' -import popoverStyle from '../components/styles/popover.scss' +import popoverScript from "../components/scripts/popover.inline" +import popoverStyle from "../components/styles/popover.scss" import { StaticResources } from "../resources" import { QuartzLogger } from "../log" import { googleFontHref } from "../theme" import { trace } from "../trace" -function addGlobalPageResources(cfg: GlobalConfiguration, reloadScript: boolean, staticResources: StaticResources, componentResources: ComponentResources) { +function addGlobalPageResources( + cfg: GlobalConfiguration, + reloadScript: boolean, + staticResources: StaticResources, + componentResources: ComponentResources, +) { staticResources.css.push(googleFontHref(cfg.theme)) // popovers @@ -33,8 +43,8 @@ function addGlobalPageResources(cfg: GlobalConfiguration, reloadScript: boolean, const tagId = cfg.analytics.tagId staticResources.js.push({ src: `https://www.googletagmanager.com/gtag/js?id=${tagId}`, - contentType: 'external', - loadTime: 'afterDOMReady', + contentType: "external", + loadTime: "afterDOMReady", }) componentResources.afterDOMLoaded.push(` window.dataLayer = window.dataLayer || []; @@ -47,8 +57,7 @@ function addGlobalPageResources(cfg: GlobalConfiguration, reloadScript: boolean, page_title: document.title, page_location: location.href, }); - });` - ) + });`) } else if (cfg.analytics?.provider === "plausible") { componentResources.afterDOMLoaded.push(plausibleScript) } @@ -60,8 +69,7 @@ function addGlobalPageResources(cfg: GlobalConfiguration, reloadScript: boolean, componentResources.afterDOMLoaded.push(` window.spaNavigate = (url, _) => window.location.assign(url) const event = new CustomEvent("nav", { detail: { slug: document.body.dataset.slug } }) - document.dispatchEvent(event)` - ) + document.dispatchEvent(event)`) } if (reloadScript) { @@ -71,12 +79,19 @@ function addGlobalPageResources(cfg: GlobalConfiguration, reloadScript: boolean, script: ` const socket = new WebSocket('ws://localhost:3001') socket.addEventListener('message', () => document.location.reload()) - ` + `, }) } } -export async function emitContent(contentFolder: string, output: string, cfg: QuartzConfig, content: ProcessedContent[], reloadScript: boolean, verbose: boolean) { +export async function emitContent( + contentFolder: string, + output: string, + cfg: QuartzConfig, + content: ProcessedContent[], + reloadScript: boolean, + verbose: boolean, +) { const perf = new PerfTimer() const log = new QuartzLogger(verbose) @@ -95,8 +110,8 @@ export async function emitContent(contentFolder: string, output: string, cfg: Qu // component specific scripts and styles const componentResources = getComponentResources(cfg.plugins) - // important that this goes *after* component scripts - // as the "nav" event gets triggered here and we should make sure + // important that this goes *after* component scripts + // as the "nav" event gets triggered here and we should make sure // that everyone else had the chance to register a listener for it addGlobalPageResources(cfg.configuration, reloadScript, staticResources, componentResources) @@ -112,7 +127,13 @@ export async function emitContent(contentFolder: string, output: string, cfg: Qu // emitter plugins for (const emitter of cfg.plugins.emitters) { try { - const emitted = await emitter.emit(contentFolder, cfg.configuration, content, staticResources, emit) + const emitted = await emitter.emit( + contentFolder, + cfg.configuration, + content, + staticResources, + emit, + ) emittedFiles += emitted.length if (verbose) { @@ -141,7 +162,7 @@ export async function emitContent(contentFolder: string, output: string, cfg: Qu const fp = rawFp as FilePath const ext = path.extname(fp) const src = path.join(contentFolder, fp) as FilePath - const name = slugifyFilePath(fp as FilePath) + ext as FilePath + const name = (slugifyFilePath(fp as FilePath) + ext) as FilePath const dest = path.join(assetsPath, name) as FilePath const dir = path.dirname(dest) as FilePath await fs.promises.mkdir(dir, { recursive: true }) // ensure dir exists diff --git a/quartz/processors/filter.ts b/quartz/processors/filter.ts index 04c14a6b..1f4496db 100644 --- a/quartz/processors/filter.ts +++ b/quartz/processors/filter.ts @@ -2,14 +2,18 @@ import { PerfTimer } from "../perf" import { QuartzFilterPluginInstance } from "../plugins/types" import { ProcessedContent } from "../plugins/vfile" -export function filterContent(plugins: QuartzFilterPluginInstance[], content: ProcessedContent[], verbose: boolean): ProcessedContent[] { +export function filterContent( + plugins: QuartzFilterPluginInstance[], + content: ProcessedContent[], + verbose: boolean, +): ProcessedContent[] { const perf = new PerfTimer() const initialLength = content.length for (const plugin of plugins) { const updatedContent = content.filter(plugin.shouldPublish) if (verbose) { - const diff = content.filter(x => !updatedContent.includes(x)) + const diff = content.filter((x) => !updatedContent.includes(x)) for (const file of diff) { console.log(`[filter:${plugin.name}] ${file[1].data.slug}`) } diff --git a/quartz/processors/parse.ts b/quartz/processors/parse.ts index db4cb872..a068899d 100644 --- a/quartz/processors/parse.ts +++ b/quartz/processors/parse.ts @@ -1,19 +1,19 @@ -import esbuild from 'esbuild' -import remarkParse from 'remark-parse' -import remarkRehype from 'remark-rehype' +import esbuild from "esbuild" +import remarkParse from "remark-parse" +import remarkRehype from "remark-rehype" import { Processor, unified } from "unified" -import { Root as MDRoot } from 'remark-parse/lib' -import { Root as HTMLRoot } from 'hast' -import { ProcessedContent } from '../plugins/vfile' -import { PerfTimer } from '../perf' -import { read } from 'to-vfile' -import { FilePath, QUARTZ, ServerSlug, slugifyFilePath } from '../path' -import path from 'path' -import os from 'os' -import workerpool, { Promise as WorkerPromise } from 'workerpool' -import { QuartzTransformerPluginInstance } from '../plugins/types' -import { QuartzLogger } from '../log' -import { trace } from '../trace' +import { Root as MDRoot } from "remark-parse/lib" +import { Root as HTMLRoot } from "hast" +import { ProcessedContent } from "../plugins/vfile" +import { PerfTimer } from "../perf" +import { read } from "to-vfile" +import { FilePath, QUARTZ, ServerSlug, slugifyFilePath } from "../path" +import path from "path" +import os from "os" +import workerpool, { Promise as WorkerPromise } from "workerpool" +import { QuartzTransformerPluginInstance } from "../plugins/types" +import { QuartzLogger } from "../log" +import { trace } from "../trace" export type QuartzProcessor = Processor export function createProcessor(transformers: QuartzTransformerPluginInstance[]): QuartzProcessor { @@ -21,16 +21,15 @@ export function createProcessor(transformers: QuartzTransformerPluginInstance[]) let processor = unified().use(remarkParse) // MD AST -> MD AST transforms - for (const plugin of transformers.filter(p => p.markdownPlugins)) { + for (const plugin of transformers.filter((p) => p.markdownPlugins)) { processor = processor.use(plugin.markdownPlugins!()) } // MD AST -> HTML AST processor = processor.use(remarkRehype, { allowDangerousHtml: true }) - // HTML AST -> HTML AST transforms - for (const plugin of transformers.filter(p => p.htmlPlugins)) { + for (const plugin of transformers.filter((p) => p.htmlPlugins)) { processor = processor.use(plugin.htmlPlugins!()) } @@ -57,23 +56,29 @@ async function transpileWorkerScript() { packages: "external", plugins: [ { - name: 'css-and-scripts-as-text', + name: "css-and-scripts-as-text", setup(build) { build.onLoad({ filter: /\.scss$/ }, (_) => ({ - contents: '', - loader: 'text' + contents: "", + loader: "text", })) build.onLoad({ filter: /\.inline\.(ts|js)$/ }, (_) => ({ - contents: '', - loader: 'text' + contents: "", + loader: "text", })) - } - } - ] + }, + }, + ], }) } -export function createFileParser(transformers: QuartzTransformerPluginInstance[], baseDir: string, fps: FilePath[], allSlugs: ServerSlug[], verbose: boolean) { +export function createFileParser( + transformers: QuartzTransformerPluginInstance[], + baseDir: string, + fps: FilePath[], + allSlugs: ServerSlug[], + verbose: boolean, +) { return async (processor: QuartzProcessor) => { const res: ProcessedContent[] = [] for (const fp of fps) { @@ -84,7 +89,7 @@ export function createFileParser(transformers: QuartzTransformerPluginInstance[] file.value = file.value.toString().trim() // Text -> Text transforms - for (const plugin of transformers.filter(p => p.textTransform)) { + for (const plugin of transformers.filter((p) => p.textTransform)) { file.value = plugin.textTransform!(file.value) } @@ -110,7 +115,12 @@ export function createFileParser(transformers: QuartzTransformerPluginInstance[] } } -export async function parseMarkdown(transformers: QuartzTransformerPluginInstance[], baseDir: string, fps: FilePath[], verbose: boolean): Promise { +export async function parseMarkdown( + transformers: QuartzTransformerPluginInstance[], + baseDir: string, + fps: FilePath[], + verbose: boolean, +): Promise { const perf = new PerfTimer() const log = new QuartzLogger(verbose) @@ -118,7 +128,9 @@ export async function parseMarkdown(transformers: QuartzTransformerPluginInstanc let concurrency = fps.length < CHUNK_SIZE ? 1 : os.availableParallelism() // get all slugs ahead of time as each thread needs a copy - const allSlugs = fps.map(fp => slugifyFilePath(path.relative(baseDir, path.resolve(fp)) as FilePath)) + const allSlugs = fps.map((fp) => + slugifyFilePath(path.relative(baseDir, path.resolve(fp)) as FilePath), + ) let res: ProcessedContent[] = [] log.start(`Parsing input files using ${concurrency} threads`) @@ -128,18 +140,15 @@ export async function parseMarkdown(transformers: QuartzTransformerPluginInstanc res = await parse(processor) } else { await transpileWorkerScript() - const pool = workerpool.pool( - './quartz/bootstrap-worker.mjs', - { - minWorkers: 'max', - maxWorkers: concurrency, - workerType: 'thread' - } - ) + const pool = workerpool.pool("./quartz/bootstrap-worker.mjs", { + minWorkers: "max", + maxWorkers: concurrency, + workerType: "thread", + }) const childPromises: WorkerPromise[] = [] for (const chunk of chunks(fps, CHUNK_SIZE)) { - childPromises.push(pool.exec('parseFiles', [baseDir, chunk, allSlugs, verbose])) + childPromises.push(pool.exec("parseFiles", [baseDir, chunk, allSlugs, verbose])) } const results: ProcessedContent[][] = await WorkerPromise.all(childPromises) diff --git a/quartz/resources.tsx b/quartz/resources.tsx index 525210b5..a185733e 100644 --- a/quartz/resources.tsx +++ b/quartz/resources.tsx @@ -2,29 +2,38 @@ import { randomUUID } from "crypto" import { JSX } from "preact/jsx-runtime" export type JSResource = { - loadTime: 'beforeDOMReady' | 'afterDOMReady' - moduleType?: 'module', + loadTime: "beforeDOMReady" | "afterDOMReady" + moduleType?: "module" spaPreserve?: boolean -} & ({ - src: string - contentType: 'external' -} | { - script: string - contentType: 'inline' -}) +} & ( + | { + src: string + contentType: "external" + } + | { + script: string + contentType: "inline" + } +) export function JSResourceToScriptElement(resource: JSResource, preserve?: boolean): JSX.Element { - const scriptType = resource.moduleType ?? 'application/javascript' + const scriptType = resource.moduleType ?? "application/javascript" const spaPreserve = preserve ?? resource.spaPreserve - if (resource.contentType === 'external') { - return + return ( + + ) } } export interface StaticResources { - css: string[], + css: string[] js: JSResource[] } diff --git a/quartz/styles/base.scss b/quartz/styles/base.scss index f0b252b5..c6e343b5 100644 --- a/quartz/styles/base.scss +++ b/quartz/styles/base.scss @@ -21,7 +21,17 @@ body { border-radius: 5px; } -p, ul, text, a, tr, td, li, ol, ul, .katex, .math { +p, +ul, +text, +a, +tr, +td, +li, +ol, +ul, +.katex, +.math { color: var(--darkgray); fill: var(--darkgray); } @@ -79,7 +89,7 @@ a { font-size: 2rem; } - & li:has(> input[type='checkbox']) { + & li:has(> input[type="checkbox"]) { list-style-type: none; padding-left: 0; margin-left: -1.4rem; @@ -144,7 +154,8 @@ a { } } - & .center, & footer { + & .center, + & footer { width: $pageWidth; margin-left: auto; margin-right: auto; @@ -195,9 +206,12 @@ thead { } } - - -h1, h2, h3, h4, h5, h6 { +h1, +h2, +h3, +h4, +h5, +h6 { &[id] > a[href^="#"] { margin: 0 0.5rem; opacity: 0; @@ -277,11 +291,11 @@ pre { } } - &[data-line-numbers-max-digits='2'] > [data-line]::before { + &[data-line-numbers-max-digits="2"] > [data-line]::before { width: 2rem; } - - &[data-line-numbers-max-digits='3'] > [data-line]::before { + + &[data-line-numbers-max-digits="3"] > [data-line]::before { width: 3rem; } } @@ -296,7 +310,9 @@ code { background: var(--lightgray); } -tbody, li, p { +tbody, +li, +p { line-height: 1.5rem; } @@ -307,7 +323,8 @@ table { border-collapse: collapse; } -td, th { +td, +th { padding: 0.2rem 1rem; border: 1px solid var(--gray); } @@ -331,7 +348,8 @@ hr { background-color: var(--lightgray); } -audio, video { +audio, +video { width: 100%; border-radius: 5px; } @@ -340,7 +358,8 @@ audio, video { flex: 1 1 auto; } -ul.overflow, ol.overflow { +ul.overflow, +ol.overflow { height: 400px; overflow-y: scroll; @@ -354,9 +373,9 @@ ul.overflow, ol.overflow { &:after { pointer-events: none; - content: ''; + content: ""; width: 100%; - height: 50px; + height: 50px; position: absolute; left: 0; bottom: 0; diff --git a/quartz/styles/callouts.scss b/quartz/styles/callouts.scss index 46dffdec..d49443e8 100644 --- a/quartz/styles/callouts.scss +++ b/quartz/styles/callouts.scss @@ -1,104 +1,104 @@ @use "sass:color"; .callout { - border: 1px solid var(--border); - background-color: var(--bg); - border-radius: 5px; - padding: 0 1rem; - overflow-y: hidden; + border: 1px solid var(--border); + background-color: var(--bg); + border-radius: 5px; + padding: 0 1rem; + overflow-y: hidden; transition: max-height 0.3s ease; & > *:nth-child(2) { margin-top: 0; } - &[data-callout="note"] { - --color: #448aff; - --border: #448aff22; - --bg: #448aff09; - } + &[data-callout="note"] { + --color: #448aff; + --border: #448aff22; + --bg: #448aff09; + } - &[data-callout="abstract"] { - --color: #00b0ff; - --border: #00b0ff22; - --bg: #00b0ff09; - } + &[data-callout="abstract"] { + --color: #00b0ff; + --border: #00b0ff22; + --bg: #00b0ff09; + } - &[data-callout="info"], &[data-callout="todo"] { - --color: #00b8d4; - --border: #00b8d422; - --bg: #00b8d409; - } + &[data-callout="info"], + &[data-callout="todo"] { + --color: #00b8d4; + --border: #00b8d422; + --bg: #00b8d409; + } - &[data-callout="tip"] { - --color: #00bfa5; - --border: #00bfa522; - --bg: #00bfa509; - } + &[data-callout="tip"] { + --color: #00bfa5; + --border: #00bfa522; + --bg: #00bfa509; + } - &[data-callout="success"] { - --color: #09ad7a; - --border: #09ad7122; - --bg: #09ad7109; - } + &[data-callout="success"] { + --color: #09ad7a; + --border: #09ad7122; + --bg: #09ad7109; + } - &[data-callout="question"] { - --color: #dba642; - --border: #dba64222; - --bg: #dba64209; - } + &[data-callout="question"] { + --color: #dba642; + --border: #dba64222; + --bg: #dba64209; + } - &[data-callout="warning"] { - --color: #db8942; - --border: #db894222; - --bg: #db894209; - } + &[data-callout="warning"] { + --color: #db8942; + --border: #db894222; + --bg: #db894209; + } - &[data-callout="failure"], &[data-callout="danger"], &[data-callout="bug"] { - --color: #db4242; - --border: #db424222; - --bg: #db424209; - } + &[data-callout="failure"], + &[data-callout="danger"], + &[data-callout="bug"] { + --color: #db4242; + --border: #db424222; + --bg: #db424209; + } - &[data-callout="example"] { - --color: #7a43b5; - --border: #7a43b522; - --bg: #7a43b509; - } + &[data-callout="example"] { + --color: #7a43b5; + --border: #7a43b522; + --bg: #7a43b509; + } + + &[data-callout="quote"] { + --color: var(--secondary); + --border: var(--lightgray); + } - &[data-callout="quote"] { - --color: var(--secondary); - --border: var(--lightgray); - } - &.is-collapsed > .callout-title > .fold { - transform: rotateZ(-90deg) + transform: rotateZ(-90deg); } } - .callout-title { - display: flex; - align-items: center; - gap: 5px; - padding: 1rem 0; - color: var(--color); + display: flex; + align-items: center; + gap: 5px; + padding: 1rem 0; + color: var(--color); - & .fold { - margin-left: 0.5rem; + & .fold { + margin-left: 0.5rem; transition: transform 0.3s ease; opacity: 0.8; cursor: pointer; } - } .callout-icon { - width: 18px; - height: 18px; + width: 18px; + height: 18px; } .callout-title-inner { - font-weight: 700; + font-weight: 700; } - diff --git a/quartz/styles/variables.scss b/quartz/styles/variables.scss index 6dd56144..f0505e4d 100644 --- a/quartz/styles/variables.scss +++ b/quartz/styles/variables.scss @@ -3,4 +3,4 @@ $mobileBreakpoint: 600px; $tabletBreakpoint: 1200px; $sidePanelWidth: 400px; $topSpacing: 6rem; -$fullPageWidth: $pageWidth + 2 * $sidePanelWidth +$fullPageWidth: $pageWidth + 2 * $sidePanelWidth; diff --git a/quartz/theme.ts b/quartz/theme.ts index 820519f2..2860e2c1 100644 --- a/quartz/theme.ts +++ b/quartz/theme.ts @@ -1,27 +1,28 @@ export interface ColorScheme { - light: string, - lightgray: string, - gray: string, - darkgray: string, - dark: string, - secondary: string, - tertiary: string, + light: string + lightgray: string + gray: string + darkgray: string + dark: string + secondary: string + tertiary: string highlight: string } export interface Theme { typography: { - header: string, - body: string, + header: string + body: string code: string - }, + } colors: { - lightMode: ColorScheme, + lightMode: ColorScheme darkMode: ColorScheme } } -const DEFAULT_SANS_SERIF = "-apple-system, BlinkMacSystemFont, \"Segoe UI\", Helvetica, Arial, sans-serif" +const DEFAULT_SANS_SERIF = + '-apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif' const DEFAULT_MONO = "ui-monospace, SFMono-Regular, SF Mono, Menlo, monospace" export function googleFontHref(theme: Theme) { const { code, header, body } = theme.typography diff --git a/quartz/trace.ts b/quartz/trace.ts index 47f96381..d9d45d2b 100644 --- a/quartz/trace.ts +++ b/quartz/trace.ts @@ -4,13 +4,17 @@ const rootFile = /.*at file:/ export function trace(msg: string, err: Error) { const stack = err.stack console.log() - console.log(chalk.bgRed.white.bold(" ERROR ") + chalk.red(` ${msg}`) + (err.message.length > 0 ? `: ${err.message}` : "")) + console.log( + chalk.bgRed.white.bold(" ERROR ") + + chalk.red(` ${msg}`) + + (err.message.length > 0 ? `: ${err.message}` : ""), + ) if (!stack) { return } let reachedEndOfLegibleTrace = false - for (const line of stack.split('\n').slice(1)) { + for (const line of stack.split("\n").slice(1)) { if (reachedEndOfLegibleTrace) { break } diff --git a/quartz/worker.ts b/quartz/worker.ts index 9c81ed0c..de5868a7 100644 --- a/quartz/worker.ts +++ b/quartz/worker.ts @@ -6,7 +6,12 @@ const transformers = config.plugins.transformers const processor = createProcessor(transformers) // only called from worker thread -export async function parseFiles(baseDir: string, fps: FilePath[], allSlugs: ServerSlug[], verbose: boolean) { +export async function parseFiles( + baseDir: string, + fps: FilePath[], + allSlugs: ServerSlug[], + verbose: boolean, +) { const parse = createFileParser(transformers, baseDir, fps, allSlugs, verbose) return parse(processor) } diff --git a/tsconfig.json b/tsconfig.json index ea8fd50f..784ab231 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,10 +1,6 @@ { "compilerOptions": { - "lib": [ - "esnext", - "DOM", - "DOM.Iterable" - ], + "lib": ["esnext", "DOM", "DOM.Iterable"], "experimentalDecorators": true, "module": "esnext", "target": "esnext", @@ -19,12 +15,6 @@ "jsx": "react-jsx", "jsxImportSource": "preact" }, - "include": [ - "**/*.ts", - "**/*.tsx", - "./package.json" - ], - "exclude": [ - "build/**/*.d.ts" - ] + "include": ["**/*.ts", "**/*.tsx", "./package.json"], + "exclude": ["build/**/*.d.ts"] }