-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* * Completes Change wiki logo #36 * Trying preview step in `build-deploy-wiki.yml` * Docs on change at `wiki/development/quartz-wiki-dev/Modifying `quarts.config.ts`.md` * * Update action to only trigger on pull requests * * Add checkout step * * Update wiki download step * * Consolidated wiki build workflow into single job * * Disabled preview step * Added config copy --------- Co-authored-by: ehharvey <[email protected]>
- Loading branch information
1 parent
5d23585
commit 0426b3c
Showing
5 changed files
with
124 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| { | ||
| "autoPairMarkdown": false, | ||
| "attachmentFolderPath": "screenshots" | ||
| "attachmentFolderPath": "screenshots", | ||
| "showUnsupportedFiles": true | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
wiki/development/quartz-wiki-dev/Modifying `quarts.config.ts`.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| This page describes notes on modifying [[quartz.config.ts]] | ||
| # Overview | ||
| * The `.github/workflows/build-deploy-wiki.yml` GitHub Action builds our wiki | ||
| * This action clones the `quartz` wiki and runs build scripts | ||
| * In order to complete #36, we have a configuration file at `wiki/quartz.config.ts` that the GitHub Action copies and uses | ||
| # How-to's | ||
| ## Changing header image | ||
| * By default, quartz will create a "Title" image using the `config.configuration.pageTitle` property | ||
| # References | ||
| * https://preemchro.me/Datadump/site-modifications#home-image | ||
| * https://quartz.jzhao.xyz/configuration |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| // Ignore these import errors | ||
| // @ts-ignore | ||
| import { QuartzConfig } from "./quartz/cfg" | ||
| // @ts-ignore | ||
| import * as Plugin from "./quartz/plugins" | ||
|
|
||
| /** | ||
| * Quartz 4.0 Configuration | ||
| * | ||
| * This is the config that we use to build emilharvey.ca/lms-2024/ | ||
| * | ||
| * Our github action uses this file when building the site. | ||
| * | ||
| * See https://quartz.jzhao.xyz/configuration for more information. | ||
| */ | ||
| const config: QuartzConfig = { | ||
| configuration: { | ||
| pageTitle: "LMS 2024 Wiki", | ||
| enableSPA: true, | ||
| enablePopovers: true, | ||
| analytics: { | ||
| provider: "plausible", | ||
| }, | ||
| locale: "en-US", | ||
| ignorePatterns: ["private", "templates", ".obsidian"], | ||
| defaultDateType: "created", | ||
| theme: { | ||
| fontOrigin: "googleFonts", | ||
| cdnCaching: true, | ||
| typography: { | ||
| header: "Schibsted Grotesk", | ||
| body: "Source Sans Pro", | ||
| code: "IBM Plex Mono", | ||
| }, | ||
| colors: { | ||
| lightMode: { | ||
| light: "#faf8f8", | ||
| lightgray: "#e5e5e5", | ||
| gray: "#b8b8b8", | ||
| darkgray: "#4e4e4e", | ||
| dark: "#2b2b2b", | ||
| secondary: "#284b63", | ||
| tertiary: "#84a59d", | ||
| highlight: "rgba(143, 159, 169, 0.15)", | ||
| textHighlight: "#fff23688", | ||
| }, | ||
| darkMode: { | ||
| light: "#161618", | ||
| lightgray: "#393639", | ||
| gray: "#646464", | ||
| darkgray: "#d4d4d4", | ||
| dark: "#ebebec", | ||
| secondary: "#7b97aa", | ||
| tertiary: "#84a59d", | ||
| highlight: "rgba(143, 159, 169, 0.15)", | ||
| textHighlight: "#b3aa0288", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| plugins: { | ||
| transformers: [ | ||
| Plugin.FrontMatter(), | ||
| Plugin.CreatedModifiedDate({ | ||
| priority: ["frontmatter", "filesystem"], | ||
| }), | ||
| Plugin.SyntaxHighlighting({ | ||
| theme: { | ||
| light: "github-light", | ||
| dark: "github-dark", | ||
| }, | ||
| keepBackground: false, | ||
| }), | ||
| Plugin.ObsidianFlavoredMarkdown({ enableInHtmlEmbed: false }), | ||
| Plugin.GitHubFlavoredMarkdown(), | ||
| Plugin.TableOfContents(), | ||
| Plugin.CrawlLinks({ markdownLinkResolution: "shortest" }), | ||
| Plugin.Description(), | ||
| Plugin.Latex({ renderEngine: "katex" }), | ||
| ], | ||
| filters: [Plugin.RemoveDrafts()], | ||
| emitters: [ | ||
| Plugin.AliasRedirects(), | ||
| Plugin.ComponentResources(), | ||
| Plugin.ContentPage(), | ||
| Plugin.FolderPage(), | ||
| Plugin.TagPage(), | ||
| Plugin.ContentIndex({ | ||
| enableSiteMap: true, | ||
| enableRSS: true, | ||
| }), | ||
| Plugin.Assets(), | ||
| Plugin.Static(), | ||
| Plugin.NotFoundPage(), | ||
| ], | ||
| }, | ||
| } | ||
|
|
||
| export default config |