| | |
| | | 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. |
| | | |
| | |
| | | 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 |
| | | }) |
| | | ``` |
| | | |
| | |
| | | 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 |
| | |
| | | - 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`. |
| | |
| | | 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 |
| | | } |
| | |
| | | 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 |
| | | } |
| | |
| | | */ |
| | | 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 |
| | | } |
| | |
| | | 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 |
| | |
| | | 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)) |
| | | |