From 0a8c38dc21eeb9aba16154f09e523b2ce762dab2 Mon Sep 17 00:00:00 2001 From: ikorihn <16367098+ikorihn@users.noreply.github.com> Date: Sun, 14 Jan 2024 02:09:41 +0900 Subject: [PATCH] fix: small typos (#686) --- docs/authoring content.md | 2 +- docs/features/breadcrumbs.md | 2 +- docs/features/explorer.md | 2 +- docs/hosting.md | 2 +- quartz/cli/handlers.js | 4 ++-- quartz/components/Breadcrumbs.tsx | 6 +++--- quartz/components/scripts/search.inline.ts | 6 +++--- 7 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/authoring content.md b/docs/authoring content.md index fa6eea2..2482140 100644 --- a/docs/authoring content.md +++ b/docs/authoring content.md @@ -2,7 +2,7 @@ title: Authoring Content --- -All of the content in your Quartz should go in the `/content` folder. The content for the home page of your Quartz lives in `content/index.md`. If you've [[index#🪴 Get Started|setup Quartz]] already, this folder should already be initailized. Any Markdown in this folder will get processed by Quartz. +All of the content in your Quartz should go in the `/content` folder. The content for the home page of your Quartz lives in `content/index.md`. If you've [[index#🪴 Get Started|setup Quartz]] already, this folder should already be initialized. Any Markdown in this folder will get processed by Quartz. It is recommended that you use [Obsidian](https://obsidian.md/) as a way to edit and maintain your Quartz. It comes with a nice editor and graphical interface to preview, edit, and link your local files and attachments. diff --git a/docs/features/breadcrumbs.md b/docs/features/breadcrumbs.md index a241aac..a701858 100644 --- a/docs/features/breadcrumbs.md +++ b/docs/features/breadcrumbs.md @@ -20,7 +20,7 @@ Component.Breadcrumbs({ rootName: "Home", // name of first/root element resolveFrontmatterTitle: true, // whether to resolve folder names through frontmatter titles hideOnRoot: true, // whether to hide breadcrumbs on root `index.md` page - showCurrentPage: true, // wether to display the current page in the breadcrumbs + showCurrentPage: true, // whether to display the current page in the breadcrumbs }) ``` diff --git a/docs/features/explorer.md b/docs/features/explorer.md index f4d54fa..b5fd379 100644 --- a/docs/features/explorer.md +++ b/docs/features/explorer.md @@ -26,7 +26,7 @@ Component.Explorer({ title: "Explorer", // title of the explorer component folderClickBehavior: "collapse", // what happens when you click a folder ("link" to navigate to folder page on click or "collapse" to collapse folder on click) folderDefaultState: "collapsed", // default state of folders ("collapsed" or "open") - useSavedState: true, // wether to use local storage to save "state" (which folders are opened) of explorer + useSavedState: true, // whether to use local storage to save "state" (which folders are opened) of explorer // Sort order: folders first, then files. Sort folders and files alphabetically sortFn: (a, b) => { ... // default implementation shown later diff --git a/docs/hosting.md b/docs/hosting.md index 9761e5b..e6340d2 100644 --- a/docs/hosting.md +++ b/docs/hosting.md @@ -225,6 +225,6 @@ pages: - public ``` -When `.gitlab-ci.yaml` is commited, GitLab will build and deploy the website as a GitLab Page. You can find the url under `Deploy > Pages` in the sidebar. +When `.gitlab-ci.yaml` is committed, GitLab will build and deploy the website as a GitLab Page. You can find the url under `Deploy > Pages` in the sidebar. By default, the page is private and only visible when logged in to a GitLab account with access to the repository but can be opened in the settings under `Deploy` -> `Pages`. diff --git a/quartz/cli/handlers.js b/quartz/cli/handlers.js index 37762a4..6f8aad1 100644 --- a/quartz/cli/handlers.js +++ b/quartz/cli/handlers.js @@ -450,7 +450,7 @@ export async function handleUpdate(argv) { try { gitPull(UPSTREAM_NAME, QUARTZ_SOURCE_BRANCH) } catch { - console.log(chalk.red("An error occured above while pulling updates.")) + console.log(chalk.red("An error occurred above while pulling updates.")) await popContentFolder(contentFolder) return } @@ -522,7 +522,7 @@ export async function handleSync(argv) { try { gitPull(ORIGIN_NAME, QUARTZ_SOURCE_BRANCH) } catch { - console.log(chalk.red("An error occured above while pulling updates.")) + console.log(chalk.red("An error occurred above while pulling updates.")) await popContentFolder(contentFolder) return } diff --git a/quartz/components/Breadcrumbs.tsx b/quartz/components/Breadcrumbs.tsx index 175f6f3..0497b64 100644 --- a/quartz/components/Breadcrumbs.tsx +++ b/quartz/components/Breadcrumbs.tsx @@ -18,15 +18,15 @@ interface BreadcrumbOptions { */ rootName: string /** - * wether to look up frontmatter title for folders (could cause performance problems with big vaults) + * Whether to look up frontmatter title for folders (could cause performance problems with big vaults) */ resolveFrontmatterTitle: boolean /** - * Wether to display breadcrumbs on root `index.md` + * Whether to display breadcrumbs on root `index.md` */ hideOnRoot: boolean /** - * Wether to display the current page in the breadcrumbs. + * Whether to display the current page in the breadcrumbs. */ showCurrentPage: boolean } diff --git a/quartz/components/scripts/search.inline.ts b/quartz/components/scripts/search.inline.ts index eff4eb1..2858e0f 100644 --- a/quartz/components/scripts/search.inline.ts +++ b/quartz/components/scripts/search.inline.ts @@ -35,12 +35,12 @@ function highlight(searchTerm: string, text: string, trim?: boolean) { if (trim) { const includesCheck = (tok: string) => tokenizedTerms.some((term) => tok.toLowerCase().startsWith(term.toLowerCase())) - const occurencesIndices = tokenizedText.map(includesCheck) + const occurrencesIndices = tokenizedText.map(includesCheck) let bestSum = 0 let bestIndex = 0 for (let i = 0; i < Math.max(tokenizedText.length - contextWindowWords, 0); i++) { - const window = occurencesIndices.slice(i, i + contextWindowWords) + const window = occurrencesIndices.slice(i, i + contextWindowWords) const windowSum = window.reduce((total, cur) => total + (cur ? 1 : 0), 0) if (windowSum >= bestSum) { bestSum = windowSum @@ -196,7 +196,7 @@ document.addEventListener("nav", async (e: unknown) => { const termLower = term.toLowerCase() let matching = tags.filter((str) => str.includes(termLower)) - // Substract matching from original tags, then push difference + // Subtract matching from original tags, then push difference if (matching.length > 0) { let difference = tags.filter((x) => !matching.includes(x))