diff --git a/content/_index.md b/content/_index.md new file mode 100644 index 0000000000000..43088bec9eec3 --- /dev/null +++ b/content/_index.md @@ -0,0 +1,15 @@ +--- +title: Plastic Labs šŸ„½ +enableToc: false +--- + +We're a research and development group working at the intersection of human and machine learning. + +Most recently, we built [Bloom](https://bloombot.ai) -- a reading and writing tutor. + +On this journey we realized that AI tools need a framework for securely and privately handling the intimate data required to unlock deeply personalized, autonomous agents. Itā€™s our mission to realize this future. + +## Blog + +[[blog/Theory-of-Mind Is All You Need]] +[[blog/Open-Sourcing Tutor-GPT]] diff --git a/content/assets/2 orders magnitude reduced cost.png b/content/assets/2 orders magnitude reduced cost.png new file mode 100644 index 0000000000000..a02a8b5694cee Binary files /dev/null and b/content/assets/2 orders magnitude reduced cost.png differ diff --git a/content/assets/ToM Discord 1.png b/content/assets/ToM Discord 1.png new file mode 100644 index 0000000000000..5c6565be60361 Binary files /dev/null and b/content/assets/ToM Discord 1.png differ diff --git a/content/assets/ToM Discord 2.png b/content/assets/ToM Discord 2.png new file mode 100644 index 0000000000000..1fe0477d86890 Binary files /dev/null and b/content/assets/ToM Discord 2.png differ diff --git a/content/assets/ToM Discord 3.png b/content/assets/ToM Discord 3.png new file mode 100644 index 0000000000000..72d7a007f2d5a Binary files /dev/null and b/content/assets/ToM Discord 3.png differ diff --git a/content/assets/ToM Flow.png b/content/assets/ToM Flow.png new file mode 100644 index 0000000000000..ff2fd198f9edd Binary files /dev/null and b/content/assets/ToM Flow.png differ diff --git a/content/assets/ToM meme.jpeg b/content/assets/ToM meme.jpeg new file mode 100644 index 0000000000000..474bfe74ea6da Binary files /dev/null and b/content/assets/ToM meme.jpeg differ diff --git a/content/assets/bloom_courtland.png b/content/assets/bloom_courtland.png new file mode 100644 index 0000000000000..835cf06a0862e Binary files /dev/null and b/content/assets/bloom_courtland.png differ diff --git a/content/assets/bloom_courtland_thoughts.png b/content/assets/bloom_courtland_thoughts.png new file mode 100644 index 0000000000000..3155a07f07607 Binary files /dev/null and b/content/assets/bloom_courtland_thoughts.png differ diff --git a/content/assets/bloom_v_khan.png b/content/assets/bloom_v_khan.png new file mode 100644 index 0000000000000..9b427885389fd Binary files /dev/null and b/content/assets/bloom_v_khan.png differ diff --git a/content/assets/bloombot langchain diagram.png b/content/assets/bloombot langchain diagram.png new file mode 100644 index 0000000000000..95c1c568fa7b0 Binary files /dev/null and b/content/assets/bloombot langchain diagram.png differ diff --git a/content/assets/human_machine_learning.jpeg b/content/assets/human_machine_learning.jpeg new file mode 100644 index 0000000000000..04c0aaf46bebe Binary files /dev/null and b/content/assets/human_machine_learning.jpeg differ diff --git a/content/assets/khan.png b/content/assets/khan.png new file mode 100644 index 0000000000000..354ec91430494 Binary files /dev/null and b/content/assets/khan.png differ diff --git a/content/assets/thought.png b/content/assets/thought.png new file mode 100644 index 0000000000000..99671ab3c3e7c Binary files /dev/null and b/content/assets/thought.png differ diff --git a/content/blog/Open-Sourcing Tutor-GPT.md b/content/blog/Open-Sourcing Tutor-GPT.md new file mode 100644 index 0000000000000..ffbd3784f99c3 --- /dev/null +++ b/content/blog/Open-Sourcing Tutor-GPT.md @@ -0,0 +1,81 @@ +--- +title: "Open-Sourcing Tutor-GPT" +enableToc: false +--- + +![[assets/human_machine_learning.jpeg]] + +## TL;DR + +Today weā€™re [open-sourcing](https://github.com/plastic-labs/tutor-gpt) Bloom, our digital [Aristotelian](https://erikhoel.substack.com/p/why-we-stopped-making-einsteins) learning companion. + +What makes [Bloom](https://bloombot.ai/) compelling is its ability to _reason pedagogically_ about the learner. That is, it uses dialogue to posit the most educationally-optimal tutoring behavior. Eliciting this from the [capability overhang](https://jack-clark.net/2023/03/21/import-ai-321-open-source-gpt3-giving-away-democracy-to-agi-companies-gpt-4-is-a-political-artifact/) involves multiple chains of [metaprompting](https://arxiv.org/pdf/2102.07350.pdf) enabling Bloom to construct a nascent academic [theory of mind](https://arxiv.org/pdf/2304.11490.pdf) for each student. + +Weā€™re not seeing this in the explosion of ā€˜chat-over-contentā€™ tools, most of which fail to capitalize on the enormous latent abilities of LLMs. Even the impressive out-of-the-box capabilities of contemporary models donā€™t achieve the necessary user intimacy. Infrastructure for that doesnā€™t exist yet šŸ‘€. + +Our mission is to facilitate personal, [agentic](https://arxiv.org/pdf/2304.03442.pdf) AI for all. So to that end, weā€™re (1) releasing Bloomā€™s architecture into the wild and (2) embarking on a journey to supercharge the kind of empowering generative agents we want to see in the world. + +## Neo-Aristotelian Tutoring + +Right now, Bloom is a reading comprehension and writing workshop tutor. You can chat with it in [Discord](https://discord.gg/bloombotai). After supplying it a passage, Bloom can coach you toward understanding or revising a piece of text. It does this by treating the user as an equal, prompting and challenging socratically. + +We started with reading and writing in natural language because (1) native language acumen is the symbolic system through which all other fluencies are learned, (2) critical dialogue is the ideal vehicle by which to do this, and (3) that's what LLMs are best at right now. + +The problem is, most students today don't have the luxury of "talking it out" with an expert interlocutor. But we know that's what works. (Perhaps too) heavily referenced in tech and academia, [Bloomā€™s 2 sigma problem](https://en.wikipedia.org/wiki/Bloom%27s_2_sigma_problem) suggests that students tutored 1:1 can perform two standard deviations better than classroom taught peers. + +Current compute suggests we can do high-grade 1:1 for two orders of magnitude cheaper marginal cost than your average human tutor. It may well be that industrial education ends up a blip in the history of learningā€”necessary for scaling edu, but eventually supplanted by a reinvention of Aristotelian models. + +![[assets/2 orders magnitude reduced cost.png]] + +It's clear generative AI stands a good chance of democratizing this kind of access and attention, but what's less clear are the specifics. It's tough to be an effective teacher that students actually want to learn from. Harder still to let the student guide the experience yet maintain an elevated discourse. + +So how do we create successful learning agents that students will eagerly use without coercion? We think this ability lies latent in base models, but the key is eliciting it. + +## Eliciting Pedagogical Reasoning + +The machine learning community has long sought to uncover the full range of tasks that large language models can be prompted to accomplish on general pre-training alone (the capability overhang). We believe we have discovered one such task: pedagogical reasoning. + +Bloom was built and prompted to elicit this specific type of teaching behavior. (The kind laborious for new teachers, but that adept ones learn to do unconsciously.) After each input it revises a userā€™s real-time academic needs, considers all the information at its disposal, and suggests to itself a framework for constructing the ideal response. + +![[assets/bloombot langchain diagram.png]] + +It consists of two ā€œchainā€ objects from [LangChain](https://python.langchain.com/en/latest/index.html) ā€”a *thought* and *response* chain. The _thought_ chain exists to prompt the model to generate a pedagogical thought about the studentā€™s inputā€”e.g. a studentā€™s mental state, learning goals, preferences for the conversation, quality of reasoning, knowledge of the text, etc. The *response*chain takes that _thought_ and generates a response. + +Each chain has a `ConversationSummaryBufferMemory` object summarizing the respective ā€œconversations.ā€ The _thought_ chain summarizes the thoughts into a rank-ordered academic needs list that gains specificity and gets reprioritized with each student input. The _response_ chain summarizes the dialogue in an attempt to avoid circular conversations and record learning progress. + +Weā€™re eliciting this behavior from [prompting alone](https://arxiv.org/pdf/2102.07350.pdf). Two of Plasticā€™s co-founders have extensive experience in education, both in private tutoring and the classroom. They employed this to craft strong example dialogues that sufficiently [demonstrated](https://github.com/plastic-labs/tutor-gpt/tree/main/data) how to respond across a range of situations. + +Take for example a situation where the student asks directly for an answer. Here is Bloomā€™s response compared to [Khanmigoā€™s](https://www.khanacademy.org/khan-labs): + +![[assets/khan.png]] + +![[assets/bloom_v_khan.png]] +![[assets/thought.png]] + +Khanmigo chides, deflects, and restates the question. Bloom levels with the student as an equalā€”itā€™s empathetic, explains _**why**_ this is a worthwhile task, then offers support starting from a different angleā€¦much like a compassionate, effective tutor. And note the thought that also informed its response ā€” an accurate imputation of the studentā€™s mental state. + +And Bloom is dynamic, even when given no excerpted context and asked about non-textual material, itā€™s able to converse naturally about student interest: + +![[assets/bloom_courtland.png]] + +and its accompanying thoughts: + +![[assets/bloom_courtland_thoughts.png]] + +Notice how Bloom reasons it should indulge the topic, validate the student, and point toward (but not supply) possible answers. Then the resultant responses are ones that do this and more, gently guiding toward a fuller comprehension and higher-fidelity understanding of the music. + +Aside from these edgier cases, Bloom shines helping students understand difficult passages (from syntactic to conceptual levels) and giving writing feedback (especially competent at thesis construction). [Take it for a spin.](https://discord.gg/udtxycbh) + +Ultimately, we hope [open-sourcing Bloom](https://github.com/plastic-labs/tutor-gpt#readme) will allow anyone to run with these elicitations and prompt to expand its utility to support other domains. Weā€™ll be doing work here too. + +## Bloom & Agentic AI + +This constitutes the beginning of an approach far superior to just slapping a chatbot UI over a content library that's probably already in a base model's pre-training. + +After all, if it were just about content delivery, MOOCs would've solved education. We need more than that to reliably grow rare minds. And we're already seeing Bloom excel at promoting synthesis and creative interpretation within its narrow utility. + +But to truly give students superpowers and liberate them from the drudgery that much of formal education has become, Bloom needs to go further. Specifically, it needs to both proactively anticipate the needs of the user and execute autonomously against that reasoning. + +It needs to excel at theory of mind, the kind of deep psychological modeling that makes for good teachers. In fact, we think that lots of AI tools are running up against this problem too. So what we're building next is infrastructure for multi-agent trustless data exchange. We think this will unlock a host of game-changing additional overhung capabilities across the landscape of artificial intelligence. + +If weā€™re to realize a world where open-source, personalized, and local models are competitive with hegemonic incumbents, one where autonomous agents represent continuous branches of truly extended minds, we need a framework for securely and privately handling the intimate data required to earn this level of trust and agency. \ No newline at end of file diff --git a/content/blog/Theory-of-Mind is All You Need.md b/content/blog/Theory-of-Mind is All You Need.md new file mode 100644 index 0000000000000..b7ca4d84b51bf --- /dev/null +++ b/content/blog/Theory-of-Mind is All You Need.md @@ -0,0 +1,80 @@ + +--- +title: "Theory-of-Mind Is All You Need" +enableToc: false +--- + +## TL;DR + +Today weā€™re releasing a major upgrade to [Bloom](https://discord.gg/bloombot.ai) (& the open-source codebase, [Tutor-GPT](https://github.com/plastic-labs/tutor-gpt)). + +We gave our tutor even more autonomy to reason about the psychology of the user, andā€”using GPT-4 to dynamically _rewrite its own_ system promptsā€”weā€™re able to dramatically expand the scope of what Bloom can do _and_ massively reduce our prompting architecture. + +We leaned into theory of mind experiments and Bloom is now more than just a literacy tutor, itā€™s an expansive learning companion. + +## Satisfying Objective Discovery + +Bloom is already excellent at helping you draft and understand language. But we want it do whatever you need. + +To expand functionality though, we faced a difficult technical problem: figuring out what the learner wants to do. + +Sounds simple (just ask), yet any teacher will tell you, students are often the last to understand what they ought to be doing. Are you learning for its own sake, or working on an assignment? What are the expectations and parameters? What preferences do you have about how this gets done? + +Explaining all this to a tutor (synthetic or biological) upfront, is laborious and tiresome. We could just add some buttons, but thatā€™s a deterministic cop-out. + +![[assets/ToM meme.jpeg]] + +What a expert educators will do is gather more information throughout the completion of the task, resolving on a more precise objective along the way; keeping the flow natural, and leaving the door open to compelling tangents and pivots. + +The key here is they donā€™t have all the informationā€”they _donā€™t know_ what the objective is preciselyā€”but being good at tutoring means turning that into an advantage, figuring it out along the way is _optimal_. The effective human tutor dynamically iterates on a set of internal models about student psychology and session objectives. So how do we recreate this in Bloom? + +Well we know that (1) foundation models are [shockingly good](https://arxiv.org/abs/2304.11490) at [theory of mind](https://en.wikipedia.org/wiki/Theory_of_mind), (2) Bloom already excels at [pedagogical reasoning](https://twitter.com/courtlandleer/status/1664673210007449605?s=20), and (3) [autonomous agents](https://twitter.com/yoheinakajima/status/1642881722495954945?s=20) are [having early success](https://twitter.com/Auto_GPT/status/1649370049688354816?s=20), so what if we stopped trying to deterministically prescribe an indeterminant intelligence? + +What if we treated Bloom with some intellectual respect? + +## Autonomous Prompting + +The solution here is scary simple. The results are scary good. + +[Hereā€™s a description](https://plasticlabs.ai/blog/Open-Sourcing-Tutor-GPT/) of the previous versionā€™s architecture: + +> Bloom was built and prompted to elicit \[pedagogical reasoning\]ā€¦After each input it revises a userā€™s real-time academic needs, considers all the information at its disposal, and suggests to itself a framework for constructing the ideal response. +> +> It consists of two ā€œchainā€ objects fromĀ [LangChain](https://python.langchain.com/en/latest/index.html)Ā ā€”aĀ _thought_Ā andĀ _response_Ā chain. TheĀ _thought_Ā chain exists to prompt the model to generate a pedagogical thought about the studentā€™s inputā€”e.g. a studentā€™s mental state, learning goals, preferences for the conversation, quality of reasoning, knowledge of the text, etc. TheĀ _response_ chain takes thatĀ _thought_Ā and generates a response. +> +> Each chain has aĀ `ConversationSummaryBufferMemory`Ā object summarizing the respective ā€œconversations.ā€ TheĀ _thought_Ā chain summarizes the thoughts into a rank-ordered academic needs list that gains specificity and gets reprioritized with each student input. TheĀ _response_Ā chain summarizes the dialogue in an attempt to avoid circular conversations and record learning progress. + +Instead, weā€™ve now repurposed the ***thought*** chain to do two things: + +- Predict the userā€™s unobserved mental state +- List the information needed to enhance that prediction + +![[assets/ToM Flow.png]] + +Then we inject that generation into the body of the response chainā€™s system prompt. We do this with every user input. Instead of just reasoning about the learnerā€™s intellectual/academic needs, Bloom now proactively rewrites itself to be as in-tune as possible to the learner at every step of the journey. + +## Emergent Effects + +Weā€™re seeing substantial positive behavior changes as a result of giving Bloom this kind of autonomy. + +![[assets/ToM Discord 1.png]] + +Bloom is more pleasant to converse with. Itā€™s still Socratic and will still push you to learn, but itā€™s not nearly as restrictive. Mainly, we posit this is a result of the tutor cohering to the user. Bloom becomes more like its interlocutor, itā€™s in many ways a mirror. This has a positive psychological effectā€”think of your favorite teacher from high school or college. + +![[assets/ToM Discord 2.png]] + +And Bloom is game. Itā€™ll go down a rabbit hole with you, help you strategize around an assignment, or just chat. Bloom displays impressive discernment between acting on theory of mind recommendations to gather more information from you and asking topically-related questions to keep up the momentum of the conversation. Itā€™s no longer obsessed with conforming to the popular stereotype of a tutor or teacher. + +![[assets/ToM Discord 3.png]] + +While reducing the prompt material, we took to opportunity to remove basically all references to ā€œtutor,ā€ ā€œstudent,ā€ etc. We found that since Bloom is no longer contaminated by pointing at [certain averaged narratives in its pre-training](https://www.lesswrong.com/posts/D7PumeYTDPfBTp3i7/the-waluigi-effect-mega-post)ā€”e.g. the (bankrupt) contemporary conception of what a tutor is ā€˜supposedā€™ to beā€”it is, ironically, a better one. + +Instead of simulating a tutor, it simulates _you_. + +## Coming Soon... + +All this begs the question: what could Bloom do with even better theory of mind? And how can we facilitate that? + +What could other AI applications do with a framework like this? + +Stay tuned. \ No newline at end of file diff --git "a/content/notes/CJK + Latex Support (\346\265\213\350\257\225).md" "b/content/notes/CJK + Latex Support (\346\265\213\350\257\225).md" new file mode 100644 index 0000000000000..0f9afc2739577 --- /dev/null +++ "b/content/notes/CJK + Latex Support (\346\265\213\350\257\225).md" @@ -0,0 +1,40 @@ +--- +title: "CJK + Latex Support (굋čƕ)" +--- + +## Chinese, Japanese, Korean Support +几乎åœØęˆ‘ä»¬ę„čƆ到之前ļ¼Œęˆ‘们已ē»ē¦»å¼€äŗ†åœ°é¢ć€‚ + +ģš°ė¦¬ź°€ ź·øź²ƒģ„ ģ•Œźø°ė„ ģ „ģ— ģš°ė¦¬ėŠ” ė•…ģ„ ė– ė‚¬ģŠµė‹ˆė‹¤. + +ē§ćŸć”恌恝悌悒ēŸ„ć‚‹ć»ć¼å‰ć«ć€ē§ćŸć”ćÆåœ°é¢ć‚’é›¢ć‚Œć¦ć„ć¾ć—ćŸć€‚ + +## Latex + +Block math works with two dollar signs `$$...$$` + +$$f(x) = \int_{-\infty}^\infty + f\hat(\xi),e^{2 \pi i \xi x} + \,d\xi$$ + +Inline math also works with single dollar signs `$...$`. For example, Euler's identity but inline: $e^{i\pi} = -1$ + +Aligned equations work quite well: + +$$ +\begin{aligned} +a &= b + c \\ &= e + f \\ +\end{aligned} +$$ + +And matrices + +$$ +\begin{bmatrix} +1 & 2 & 3 \\ +a & b & c +\end{bmatrix} +$$ + +## RTL +More information on configuring RTL languages like Arabic in the [config](notes/config.md) page. diff --git a/content/notes/callouts.md b/content/notes/callouts.md new file mode 100644 index 0000000000000..a9b2104e5a891 --- /dev/null +++ b/content/notes/callouts.md @@ -0,0 +1,63 @@ +--- +title: "Callouts" +--- + +## Callout support + +Quartz supports the same Admonition-callout syntax as Obsidian. + +This includes +- 12 Distinct callout types (each with several aliases) +- Collapsable callouts + +See [documentation on supported types and syntax here](https://help.obsidian.md/Editing+and+formatting/Callouts). + +## Showcase + +> [!EXAMPLE] Examples +> +> Aliases: example + +> [!note] Notes +> +> Aliases: note + +> [!abstract] Summaries +> +> Aliases: abstract, summary, tldr + +> [!info] Info +> +> Aliases: info, todo + +> [!tip] Hint +> +> Aliases: tip, hint, important + +> [!success] Success +> +> Aliases: success, check, done + +> [!question] Question +> +> Aliases: question, help, faq + +> [!warning] Warning +> +> Aliases: warning, caution, attention + +> [!failure] Failure +> +> Aliases: failure, fail, missing + +> [!danger] Error +> +> Aliases: danger, error + +> [!bug] Bug +> +> Aliases: bug + +> [!quote] Quote +> +> Aliases: quote, cite diff --git a/content/notes/config.md b/content/notes/config.md new file mode 100644 index 0000000000000..250f34c2a75fd --- /dev/null +++ b/content/notes/config.md @@ -0,0 +1,228 @@ +--- +title: "Configuration" +tags: +- setup +weight: 0 +--- + +## Configuration +Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you'd like to get. + +The majority of configuration can be found under `data/config.yaml`. An annotated example configuration is shown below. + +```yaml {title="data/config.yaml"} +# The name to display in the footer +name: Jacky Zhao + +# whether to globally show the table of contents on each page +# this can be turned off on a per-page basis by adding this to the +# front-matter of that note +enableToc: true + +# whether to by-default open or close the table of contents on each page +openToc: false + +# whether to display on-hover link preview cards +enableLinkPreview: true + +# whether to render titles for code blocks +enableCodeBlockTitle: true + +# whether to render copy buttons for code blocks +enableCodeBlockCopy: true + +# whether to render callouts +enableCallouts: true + +# whether to try to process Latex +enableLatex: true + +# whether to enable single-page-app style rendering +# this prevents flashes of unstyled content and improves +# smoothness of Quartz. More info in issue #109 on GitHub +enableSPA: true + +# whether to render a footer +enableFooter: true + +# whether backlinks of pages should show the context in which +# they were mentioned +enableContextualBacklinks: true + +# whether to show a section of recent notes on the home page +enableRecentNotes: false + +# whether to display an 'edit' button next to the last edited field +# that links to github +enableGitHubEdit: false +GitHubLink: https://github.com/jackyzha0/quartz/tree/hugo/content + +# whether to render mermaid diagrams +enableMermaid: true + +# whether to use Operand to power semantic search +# IMPORTANT: replace this API key with your own if you plan on using +# Operand search! +search: + enableSemanticSearch: false + operandApiKey: "REPLACE-WITH-YOUR-OPERAND-API-KEY" + operandIndexId: "REPLACE-WITH-YOUR-OPERAND-INDEX-ID" + +# page description used for SEO +description: + Host your second brain and digital garden for free. Quartz features extremely fast full-text search, + Wikilink support, backlinks, local graph, tags, and link previews. + +# title of the home page (also for SEO) +page_title: + "šŸŖ“ Quartz 3.3" + +# links to show in the footer +links: + - link_name: Twitter + link: https://twitter.com/_jzhao + - link_name: Github + link: https://github.com/jackyzha0 +``` + +### Code Block Titles +To add code block titles with Quartz: + +1. Ensure that code block titles are enabled in Quartz's configuration: + + ```yaml {title="data/config.yaml", linenos=false} + enableCodeBlockTitle: true + ``` + +2. Add the `title` attribute to the desired [code block + fence](https://gohugo.io/content-management/syntax-highlighting/#highlighting-in-code-fences): + + ```markdown {linenos=false} + ```yaml {title="data/config.yaml"} + enableCodeBlockTitle: true # example from step 1 + ``` + ``` + +**Note** that if `{title=}` is included, and code block titles are not +enabled, no errors will occur, and the title attribute will be ignored. + +### HTML Favicons +If you would like to customize the favicons of your Quartz-based website, you +can add them to the `data/config.yaml` file. The **default** without any set +`favicon` key is: + +```html {title="layouts/partials/head.html", linenostart=15} + +``` + +The default can be overridden by defining a value to the `favicon` key in your +`data/config.yaml` file. For example, here is a `List[Dictionary]` example format, which is +equivalent to the default: + +```yaml {title="data/config.yaml", linenos=false} +favicon: + - { rel: "shortcut icon", href: "icon.png", type: "image/png" } +# - { ... } # Repeat for each additional favicon you want to add +``` + +In this format, the keys are identical to their HTML representations. + +If you plan to add multiple favicons generated by a website (see list below), it +may be easier to define it as HTML. Here is an example which appends the +**Apple touch icon** to Quartz's default favicon: + +```yaml {title="data/config.yaml", linenos=false} +favicon: | + + +``` + +This second favicon will now be used as a web page icon when someone adds your +webpage to the home screen of their Apple device. If you are interested in more +information about the current and past standards of favicons, you can read +[this article](https://www.emergeinteractive.com/insights/detail/the-essentials-of-favicons/). + +**Note** that all generated favicon paths, defined by the `href` +attribute, are relative to the `static/` directory. + +### Graph View +To customize the Interactive Graph view, you can poke around `data/graphConfig.yaml`. + +```yaml {title="data/graphConfig.yaml"} +# if true, a Global Graph will be shown on home page with full width, no backlink. +# A different set of Local Graphs will be shown on sub pages. +# if false, Local Graph will be default on every page as usual +enableGlobalGraph: false + +### Local Graph ### +localGraph: + # whether automatically generate a legend + enableLegend: false + + # whether to allow dragging nodes in the graph + enableDrag: true + + # whether to allow zooming and panning the graph + enableZoom: true + + # how many neighbours of the current node to show (-1 is all nodes) + depth: 1 + + # initial zoom factor of the graph + scale: 1.2 + + # how strongly nodes should repel each other + repelForce: 2 + + # how strongly should nodes be attracted to the center of gravity + centerForce: 1 + + # what the default link length should be + linkDistance: 1 + + # how big the node labels should be + fontSize: 0.6 + + # scale at which to start fading the labes on nodes + opacityScale: 3 + +### Global Graph ### +globalGraph: + # same settings as above + +### For all graphs ### +# colour specific nodes path off of their path +paths: + - /moc: "#4388cc" +``` + + +## Styling +Want to go even more in-depth? You can add custom CSS styling and change existing colours through editing `assets/styles/custom.scss`. If you'd like to target specific parts of the site, you can add ids and classes to the HTML partials in `/layouts/partials`. + +### Partials +Partials are what dictate what gets rendered to the page. Want to change how pages are styled and structured? You can edit the appropriate layout in `/layouts`. + +For example, the structure of the home page can be edited through `/layouts/index.html`. To customize the footer, you can edit `/layouts/partials/footer.html` + +More info about partials on [Hugo's website.](https://gohugo.io/templates/partials/) + +Still having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md). + +## Language Support +[CJK + Latex Support (굋čƕ)](notes/CJK%20+%20Latex%20Support%20(굋čƕ).md) comes out of the box with Quartz. + +Want to support languages that read from right-to-left (like Arabic)? Hugo (and by proxy, Quartz) supports this natively. + +Follow the steps [Hugo provides here](https://gohugo.io/content-management/multilingual/#configure-languages) and modify your `config.toml` + +For example: + +```toml +defaultContentLanguage = 'ar' +[languages] + [languages.ar] + languagedirection = 'rtl' + title = 'Ł…ŲÆŁˆŁ†ŲŖŁŠ' + weight = 1 +``` diff --git a/content/notes/custom Domain.md b/content/notes/custom Domain.md new file mode 100644 index 0000000000000..72cb466eb5b1f --- /dev/null +++ b/content/notes/custom Domain.md @@ -0,0 +1,17 @@ +--- +title: "Custom Domain" +--- + +### Registrar +This step is only applicable if you are using a **custom domain**! If you are using a `.github.io` domain, you can skip this step. + +For this last bit to take effect, you also need to create a CNAME record with the DNS provider you register your domain with (i.e. NameCheap, Google Domains). + +GitHub has some [documentation on this](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site), but the tldr; is to + +1. Go to your forked repository (`github.com//quartz`) settings page and go to the Pages tab. Under "Custom domain", type your custom domain, then click **Save**. +2. Go to your DNS Provider and create a CNAME record that points from your domain to ` šŸ”— Step 3: [How to setup your Obsidian Vault to work with Quartz](notes/obsidian.md) + +## Previewing Changes +This step is purely optional and mostly for those who want to see the published version of their digital garden locally before opening it up to the internet. This is *highly recommended* but not required. + +> šŸ‘€ Step 4: [Preview Quartz Changes](notes/preview%20changes.md) + +For those who like to live life more on the edge, viewing the garden through Obsidian gets you pretty close to the real thing. + +## Publishing Changes +Now that you know the basics of managing your digital garden using Quartz, you can publish it to the internet! + +> šŸŒ Step 5: [Hosting Quartz online!](notes/hosting.md) + +Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md). diff --git a/content/notes/hosting.md b/content/notes/hosting.md new file mode 100644 index 0000000000000..e29f442238e20 --- /dev/null +++ b/content/notes/hosting.md @@ -0,0 +1,99 @@ +--- +title: "Deploying Quartz to the Web" +tags: +- setup +weight: -1 +aliases: +- hosting +--- + +## Hosting on GitHub Pages +Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go! Follow the steps below. + +### Enable GitHub Actions Permissions +By default, GitHub disables workflows from modifying your files (for good reason!). However, Quartz needs this to write the actual site files back to GitHub. + +Head to `Settings > Action > General > Workflow Permissions` and choose `Read and Write Permissions` + +![[notes/images/github-actions.png]] +*Enable GitHub Actions* + +### Enable GitHub Pages + +Head to the 'Settings' tab of your forked repository and go to the 'Pages' tab. + +1. (IMPORTANT) Set the source to deploy from `master` (and not `hugo`) using `/ (root)` +2. Set a custom domain here if you have one! + +![Enable GitHub Pages](/notes/images/github-pages.png)*Enable GitHub Pages* + +### Pushing Changes +To see your changes on the internet, we need to push it them to GitHub. Quartz is a `git` repository so updating it is the same workflow as you would follow as if it were just a regular software project. + +```shell +# Navigate to Quartz folder +cd + +# Commit all changes +git add . +git commit -m "message describing changes" + +# Push to GitHub to update site +git push origin hugo +``` + +Note: we specifically push to the `hugo` branch here. Our GitHub action automatically runs everytime a push to is detected to that branch and then updates the `master` branch for redeployment. + +### Setting up the Site +Now let's get this site up and running. Never hosted a site before? No problem. Have a fancy custom domain you already own or want to subdomain your Quartz? That's easy too. + +Here, we take advantage of GitHub's free page hosting to deploy our site. Change `baseURL` in `/config.toml`. + +Make sure that your `baseURL` has a trailing `/`! + +[Reference `config.toml` here](https://github.com/jackyzha0/quartz/blob/hugo/config.toml) + +```toml +baseURL = "https:///" +``` + +If you are using this under a subdomain (e.g. `.github.io/quartz`), include the trailing `/`. **You need to do this especially if you are using GitHub!** + +```toml +baseURL = "https://.github.io/quartz/" +``` + +Change `cname` in `/.github/workflows/deploy.yaml`. Again, if you don't have a custom domain to use, you can use `.github.io`. + +Please note that the `cname` field should *not* have any path `e.g. end with /quartz` or have a trailing `/`. + +[Reference `deploy.yaml` here](https://github.com/jackyzha0/quartz/blob/hugo/.github/workflows/deploy.yaml) + +```yaml {title=".github/workflows/deploy.yaml"} +- name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} # this can stay as is, GitHub fills this in for us! + publish_dir: ./public + publish_branch: master + cname: +``` + +Have a custom domain? [Learn how to set it up with Quartz ](notes/custom%20Domain.md). + +### Ignoring Files +Only want to publish a subset of all of your notes? Don't worry, Quartz makes this a simple two-step process. + +āŒ [Excluding pages from being published](notes/ignore%20notes.md) + +## Docker Support +If you don't want to use a hosting service, you can host using [Docker](notes/docker.md) instead! +I would *not use this method* unless you know what you are doing. + +--- + +Now that your Quartz is live, let's figure out how to make Quartz really *yours*! + +> Step 6: šŸŽØ [Customizing Quartz](notes/config.md) + +Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md). diff --git a/content/notes/ignore notes.md b/content/notes/ignore notes.md new file mode 100644 index 0000000000000..e0314211dc49a --- /dev/null +++ b/content/notes/ignore notes.md @@ -0,0 +1,31 @@ +--- +title: "Ignoring Notes" +--- + +### Quartz Ignore +Edit `ignoreFiles` in `config.toml` to include paths you'd like to exclude from being rendered. + +```toml +... +ignoreFiles = [ + "/content/templates/*", + "/content/private/*", + "" +] +``` + +`ignoreFiles` supports the use of Regular Expressions (RegEx) so you can ignore patterns as well (e.g. ignoring all `.png`s by doing `\\.png$`). +To ignore a specific file, you can also add the tag `draft: true` to the frontmatter of a note. + +```markdown +--- +title: Some Private Note +draft: true +--- +... +``` + +More details in [Hugo's documentation](https://gohugo.io/getting-started/configuration/#ignore-content-and-data-files-when-rendering). + +### Global Ignore +However, just adding to the `ignoreFiles` will only prevent the page from being access through Quartz. If you want to prevent the file from being pushed to GitHub (for example if you have a public repository), you need to also add the path to the `.gitignore` file at the root of the repository. \ No newline at end of file diff --git a/content/notes/images/fork.png b/content/notes/images/fork.png new file mode 100644 index 0000000000000..cbf7f86fbeaa6 Binary files /dev/null and b/content/notes/images/fork.png differ diff --git a/content/notes/images/github-actions.png b/content/notes/images/github-actions.png new file mode 100644 index 0000000000000..f7342df9c3ad8 Binary files /dev/null and b/content/notes/images/github-actions.png differ diff --git a/content/notes/images/github-pages.png b/content/notes/images/github-pages.png new file mode 100644 index 0000000000000..2c606f588f226 Binary files /dev/null and b/content/notes/images/github-pages.png differ diff --git a/content/notes/images/google-domains.png b/content/notes/images/google-domains.png new file mode 100644 index 0000000000000..a43826999d4f9 Binary files /dev/null and b/content/notes/images/google-domains.png differ diff --git a/content/notes/images/obsidian-settings.png b/content/notes/images/obsidian-settings.png new file mode 100644 index 0000000000000..c4f32f6cc4970 Binary files /dev/null and b/content/notes/images/obsidian-settings.png differ diff --git a/content/notes/obsidian.md b/content/notes/obsidian.md new file mode 100644 index 0000000000000..fb5f3d5bdd117 --- /dev/null +++ b/content/notes/obsidian.md @@ -0,0 +1,37 @@ +--- +title: "Obsidian Vault Integration" +tags: +- setup +weight: -3 +--- + +## Setup +Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have. + +### New Vault +If you don't have an existing Vault, [download Obsidian](https://obsidian.md/) and create a new Vault in the `/content` folder that you created and cloned during the [setup](notes/setup.md) step. + +### Linking an existing Vault +The easiest way to use an existing Vault is to copy all of your files (directory and hierarchies intact) into the `/content` folder. + +## Settings +Great, now that you have your Obsidian linked to your Quartz, let's fix some settings so that they play well. + +Open Settings > Files & Links and look for these two items: + +1. Set the **New link format** to **Absolute Path in vault**. If you have a completely flat vault (no folders), this step isn't necessary. +2. Turn **on** the **Automatically update internal links** setting. + + +![[notes/images/obsidian-settings.png]]*Obsidian Settings* + +## Templates +Inserting front matter everytime you want to create a new Note gets annoying really quickly. Luckily, Obsidian supports templates which makes inserting new content really easily. + +> [!WARNING] +> +> **If you decide to overwrite the `/content` folder completely, don't remove the `/content/templates` folder!** + +Head over to Options > Core Plugins and enable the Templates plugin. Then go to Options > Hotkeys and set a hotkey for 'Insert Template' (I recommend `[cmd]+T`). That way, when you create a new note, you can just press the hotkey for a new template and be ready to go! + +> šŸ‘€ Step 4: [Preview Quartz Changes](notes/preview%20changes.md) diff --git a/content/notes/philosophy.md b/content/notes/philosophy.md new file mode 100644 index 0000000000000..bf04da3b1bbe6 --- /dev/null +++ b/content/notes/philosophy.md @@ -0,0 +1,17 @@ +--- +title: "Quartz Philosophy" +--- + +> ā€œ[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 + +## Why Quartz? +Hosting a public digital garden isn't easy. There are an overwhelming number of tutorials, resources, and guides for tools like [Notion](https://www.notion.so/), [Roam](https://roamresearch.com/), and [Obsidian](https://obsidian.md/), yet none of them have super easy to use *free* tools to publish that garden to the world. + +I've personally found that +1. It's nice to access notes from anywhere +2. Having a public digital garden invites open conversations +3. It makes keeping personal notes and knowledge *playful and fun* + +I was really inspired by [Bianca](https://garden.bianca.digital/) and [Joel](https://joelhooks.com/digital-garden)'s digital gardens and wanted to try making my own. + +**The goal of Quartz is to make hosting your own public digital garden free and simple.** You don't even need your own website. Quartz does all of that for you and gives your own little corner of the internet. diff --git a/content/notes/preview changes.md b/content/notes/preview changes.md new file mode 100644 index 0000000000000..6ce7fc0517013 --- /dev/null +++ b/content/notes/preview changes.md @@ -0,0 +1,41 @@ +--- +title: "Preview Changes" +tags: +- setup +weight: -2 +--- + +If you'd like to preview what your Quartz site looks like before deploying it to the internet, the following +instructions guide you through installing the proper dependencies to run it locally. + + +## Install `hugo-obsidian` +This step will generate the list of backlinks for Hugo to parse. Ensure you have [Go](https://golang.org/doc/install) (>= 1.16) installed. + +```bash +# Install and link `hugo-obsidian` locally +go install github.com/jackyzha0/hugo-obsidian@latest +``` + +If you are running into an error saying that `command not found: hugo-obsidian`, make sure you set your `GOPATH` correctly (see [[notes/troubleshooting#`command not found: hugo-obsidian`|the troubleshooting page]])! This will allow your terminal to correctly recognize hugo-obsidian as an executable. + +## Installing Hugo +Hugo is the static site generator that powers Quartz. [Install Hugo with "extended" Sass/SCSS version](https://gohugo.io/getting-started/installing/) first. Then, + +```bash +# Navigate to your local Quartz folder +cd + +# Start local server +make serve + +# View your site in a browser at http://localhost:1313/ +``` + +> [!INFO] Docker Support +> +> If you have the Docker CLI installed already, you can avoid installing `hugo-obsidian` and `hugo`. Instead, open your terminal, navigate to your folder with Quartz and run `make docker` + +Afterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated! Now, let's get it hosted online. + +> šŸŒ Step 5: [Hosting Quartz online!](notes/hosting.md) diff --git a/content/notes/search.md b/content/notes/search.md new file mode 100644 index 0000000000000..04576936598d7 --- /dev/null +++ b/content/notes/search.md @@ -0,0 +1,37 @@ +--- +title: "Search" +--- + +Quartz supports two modes of searching through content. + +## Full-text +Full-text search is the default in Quartz. It produces results that *exactly* match the search query. This is easier to setup but usually produces lower quality matches. + +```yaml {title="data/config.yaml"} +# the default option +enableSemanticSearch: false +``` + +## Natural Language +Natural language search is powered by [Operand](https://beta.operand.ai/). It understands language like a person does and finds results that best match user intent. In this sense, it is closer to how Google Search works. + +Natural language search tends to produce higher quality results than full-text search. + +Here's how to set it up. + +1. Login or Register for a new Operand account. Click the verification link sent to your email, and you'll be redirected to the dashboard. (Note) You do not need to enter a credit card to create an account, or get started with the Operand API. The first $10 of usage each month is free. To learn more, see pricing. If you go over your free quota, we'll (politely) reach out and ask you to configure billing. +2. Create your first index. On the dashboard, under "Indexes", enter the name and description of your index, and click "Create Index". Note down the ID of the index (obtained by clicking on the index name in the list of indexes), as you'll need it in the next step. IDs are unique to each index, and look something like `uqv1duxxbdxu`. +3. Click into the index you've created. Under "Index Something", select "SITEMAP" from the dropdown and click "Add Source". +4. For the "Sitemap.xml URL", put your deployed site's base URL followed by `sitemap.xml`. For example, for `quartz.jzhao.xyz`, put `https://quartz.jzhao.xyz/sitemap.xml`. Leave the URL Regex empty. +5. Get your API key. On the dashboard, under "API Keys", you can manage your API keys. If you don't already have an API key, click "Create API Key". You'll need this for the next step. +6. Open `data/config.yaml`. Set `enableSemanticSearch` to `true`, `operandApiKey` to your copied key, and `operandIndexId` to the ID of the index we created from earlier.. + +```yaml {title="data/config.yaml"} +# the default option +search: + enableSemanticSearch: true + operandApiKey: "jp9k5hudse2a828z98kxd6z3payi8u90rnjf" + operandIndexId: "s0kf3bd6tldw" +``` +7. Push your changes to the site and wait for it to deploy. +8. Check the Operand dashboard and wait for your site to index. Enjoy natural language search powered by Operand! diff --git a/content/notes/setup.md b/content/notes/setup.md new file mode 100644 index 0000000000000..0230132630ad0 --- /dev/null +++ b/content/notes/setup.md @@ -0,0 +1,36 @@ +--- +title: "Setup" +tags: +- setup +weight: -5 +--- + +## Making your own Quartz +Setting up Quartz requires a basic understanding of `git`. If you are unfamiliar, [this resource](https://resources.nwplus.io/2-beginner/how-to-git-github.html) is a great place to start! + +### Forking +> A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project. + +Navigate to the GitHub repository for the Quartz project: + +šŸ“ [Quartz Repository](https://github.com/jackyzha0/quartz) + +Then, Fork the repository into your own GitHub account. **Make sure that when you fork, you _uncheck_ the 'Copy the `hugo` branch only' option**. + +If you don't have an account, you can make on for free [here](https://github.com/join). More details about forking a repo can be found on [GitHub's documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo). + +![[notes/images/fork.png]] + +### Cloning +After you've made a fork of the repository, you need to download the files locally onto your machine. Ensure you have `git`, then type the following command in your terminal replacing `YOUR-USERNAME` with your GitHub username. + +```shell +git clone https://github.com/YOUR-USERNAME/quartz +``` + +## Editing +Great! Now you have everything you need to start editing and growing your digital garden. If you're ready to start writing content already, check out the recommended flow for editing notes in Quartz. + +> āœļø Step 2: [Editing Notes in Quartz](notes/editing.md) + +Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md). diff --git a/content/notes/showcase.md b/content/notes/showcase.md new file mode 100644 index 0000000000000..5004437afc513 --- /dev/null +++ b/content/notes/showcase.md @@ -0,0 +1,28 @@ +--- +title: "Showcase" +--- + +Want to see what Quartz can do? Here are some cool community gardens :) + +- [Quartz Documentation (this site!)](https://quartz.jzhao.xyz/) +- [Jacky Zhao's Garden](https://jzhao.xyz/) +- [Scaling Synthesis - A hypertext research notebook](https://scalingsynthesis.com/) +- [AWAGMI Intern Notes](https://notes.awagmi.xyz/) +- [Shihyu's PKM](https://shihyuho.github.io/pkm/) +- [SlRvb's Site](https://slrvb.github.io/Site/) +- [Course notes for Information Technology Advanced Theory](https://a2itnotes.github.io/quartz/) +- [Brandon Boswell's Garden](https://brandonkboswell.com) +- [Siyang's Courtyard](https://siyangsun.github.io/courtyard/) +- [Data Dictionary šŸ§ ](https://glossary.airbyte.com/) +- [sspaeti.com's Second Brain](https://brain.sspaeti.com/) +<<<<<<<< HEAD:docs/showcase.md +- [oldwinter ć®ę•°å­—čŠ±å›­](https://garden.oldwinter.top/) +======== +- [oldwinterć®ę•°å­—čŠ±å›­](https://garden.oldwinter.top/) +- [SethMB Work](https://sethmb.xyz/) +>>>>>>>> 1cc21a28 (chore: migrate content):content/notes/showcase.md +- [Abhijeet's Math Wiki](https://abhmul.github.io/quartz/Math-Wiki/) +- [Mike's AI Garden šŸ¤–šŸŖ“](https://mwalton.me/) +- [Matt Dunn's Second Brain](https://mattdunn.info/) + +If you want to see your own on here, submit a [Pull Request adding yourself to this file](https://github.com/jackyzha0/quartz/blob/hugo/content/notes/showcase.md)! diff --git a/content/notes/troubleshooting.md b/content/notes/troubleshooting.md new file mode 100644 index 0000000000000..aa1d897a41951 --- /dev/null +++ b/content/notes/troubleshooting.md @@ -0,0 +1,86 @@ +--- +title: "Troubleshooting and FAQ" +--- + +Still having trouble? Here are a list of common questions and problems people encounter when installing Quartz. + +While you're here, join our [Discord](https://discord.gg/cRFFHYye7t) :) + +### Does Quartz have Latex support? +Yes! See [CJK + Latex Support (굋čƕ)](notes/CJK%20+%20Latex%20Support%20(굋čƕ).md) for a brief demo. + +### Can I use \ in Quartz? +Unless it produces direct Markdown output in the file, no. There currently is no way to bundle plugin code with Quartz. + +The easiest way would be to add your own HTML partial that supports the functionality you are looking for. + +### My GitHub pages is just showing the README and not Quartz +Make sure you set the source to deploy from `master` (and not `hugo`) using `/ (root)`! See more in the [hosting](/notes/hosting) guide + +### Some of my pages have 'January 1, 0001' as the last modified date +This is a problem caused by `git` treating files as case-insensitive by default and some of your posts probably have capitalized file names. You can turn this off in your Quartz by running this command. + +```shell +# in the root of your Quartz (same folder as config.toml) +git config core.ignorecase true + +# or globally (not recommended) +git config --global core.ignorecase true +``` + +### Can I publish only a subset of my pages? +Yes! Quartz makes selective publishing really easy. Heres a guide on [excluding pages from being published](notes/ignore%20notes.md). + +### Can I host this myself and not on GitHub Pages? +Yes! All built files can be found under `/public` in the `master` branch. More details under [hosting](notes/hosting.md). + +### `command not found: hugo-obsidian` +Make sure you set your `GOPATH` correctly! This will allow your terminal to correctly recognize `hugo-obsidian` as an executable. + +```shell +# Add the following 2 lines to your ~/.bash_profile (~/.zshrc if you are on Mac) +export GOPATH=/Users/$USER/go +export PATH=$GOPATH/bin:$PATH + +# In your current terminal, to reload the session +source ~/.bash_profile # again, (~/.zshrc if you are on Mac) +``` + +### How come my notes aren't being rendered? +You probably forgot to include front matter in your Markdown files. You can either setup [Obsidian](notes/obsidian.md) to do this for you or you need to manually define it. More details in [the 'how to edit' guide](notes/editing.md). + +### My custom domain isn't working! +Walk through the steps in [the hosting guide](notes/hosting.md) again. Make sure you wait 30 min to 1 hour for changes to take effect. + +### How do I setup analytics? +Quartz by default uses [Plausible](https://plausible.io/) for analytics. + +If you would prefer to use Google Analytics, you can follow this [guide in the Hugo documentation](https://gohugo.io/templates/internal/#google-analytics). + +Alternatively, you can also import your Google Analytics data into Plausible by [following this guide](https://plausible.io/docs/google-analytics-import). + + +### How do I change the content on the home page? +To edit the main home page, open `/content/_index.md`. + +### How do I change the colours? +You can change the theme by editing `assets/custom.scss`. More details on customization and themeing can be found in the [customization guide](notes/config.md). + +### How do I add images? +You can put images anywhere in the `/content` folder. + +```markdown +Example image (source is in content/notes/images/example.png) +![Example Image](/content/notes/images/example.png) +``` + +### My Interactive Graph and Backlinks aren't up to date +By default, the `linkIndex.json` (which Quartz needs to generate the Interactive Graph and Backlinks) are not regenerated locally. To set that up, see the guide on [local editing](notes/editing.md) + +### Can I use React/Vue/some other framework? +Not out of the box. You could probably make it work by editing `/layouts/_default/single.html` but that's not what Quartz is designed to work with. 99% of things you are trying to do with those frameworks you can accomplish perfectly fine using just vanilla HTML/CSS/JS. + +## Still Stuck? +Quartz isn't perfect! If you're still having troubles, file an issue in the GitHub repo with as much information as you can reasonably provide. Alternatively, you can message me on [Twitter](https://twitter.com/_jzhao) and I'll try to get back to you as soon as I can. + +šŸ› [Submit an Issue](https://github.com/jackyzha0/quartz/issues) diff --git a/content/notes/updating.md b/content/notes/updating.md new file mode 100644 index 0000000000000..ef4688e999657 --- /dev/null +++ b/content/notes/updating.md @@ -0,0 +1,34 @@ +--- +title: "Updating" +aliases: +- update +--- + +Haven't updated Quartz in a while and want all the cool new optimizations? On Unix/Mac systems you can run the following command for a one-line update! This command will show you a log summary of all commits since you last updated, press `q` to acknowledge this. Then, it will show you each change in turn and press `y` to accept the patch or `n` to reject it. Usually you should press `y` for most of these unless it conflicts with existing changes you've made! + +```shell +make update +``` + +Or, if you don't want the interactive parts and just want to force update your local garden (this assumed that you are okay with some of your personalizations been overriden!) + +```shell +make update-force +``` + +Or, manually checkout the changes yourself. + +> [!warning] Warning! +> +> If you customized the files in `data/`, or anything inside `layouts/`, your customization may be overwritten! +> Make sure you have a copy of these changes if you don't want to lose them. + + +```shell +# add Quartz as a remote host +git remote add upstream git@github.com:jackyzha0/quartz.git + +# index and fetch changes +git fetch upstream +git checkout -p upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss config.toml data +``` diff --git a/content/templates/post.md b/content/templates/post.md new file mode 100644 index 0000000000000..c2a9b3376f06d --- /dev/null +++ b/content/templates/post.md @@ -0,0 +1,3 @@ +--- +title: "{{title}}" +--- diff --git a/docs/showcase.md b/docs/showcase.md index 6814dd06de619..3c666bb160c1f 100644 --- a/docs/showcase.md +++ b/docs/showcase.md @@ -1,18 +1,26 @@ --- -title: "Quartz Showcase" +title: "Showcase" --- -Want to see what Quartz can do? Here are some cool community gardens: +Want to see what Quartz can do? Here are some cool community gardens :) - [Quartz Documentation (this site!)](https://quartz.jzhao.xyz/) - [Jacky Zhao's Garden](https://jzhao.xyz/) -- [Brandon Boswell's Garden](https://brandonkboswell.com) - [Scaling Synthesis - A hypertext research notebook](https://scalingsynthesis.com/) - [AWAGMI Intern Notes](https://notes.awagmi.xyz/) +- [Shihyu's PKM](https://shihyuho.github.io/pkm/) +- [SlRvb's Site](https://slrvb.github.io/Site/) - [Course notes for Information Technology Advanced Theory](https://a2itnotes.github.io/quartz/) +- [Brandon Boswell's Garden](https://brandonkboswell.com) +- [Siyang's Courtyard](https://siyangsun.github.io/courtyard/) - [Data Dictionary šŸ§ ](https://glossary.airbyte.com/) - [sspaeti.com's Second Brain](https://brain.sspaeti.com/) +<<<<<<<< HEAD:docs/showcase.md - [oldwinter ć®ę•°å­—čŠ±å›­](https://garden.oldwinter.top/) +======== +- [oldwinterć®ę•°å­—čŠ±å›­](https://garden.oldwinter.top/) +- [SethMB Work](https://sethmb.xyz/) +>>>>>>>> 1cc21a28 (chore: migrate content):content/notes/showcase.md - [Abhijeet's Math Wiki](https://abhmul.github.io/quartz/Math-Wiki/) - [Mike's AI Garden šŸ¤–šŸŖ“](https://mwalton.me/) - [Matt Dunn's Second Brain](https://mattdunn.info/) @@ -21,4 +29,8 @@ Want to see what Quartz can do? Here are some cool community gardens: - [šŸ§ šŸŒ³ Chad's Mind Garden](https://www.chadly.net/) - [Pedro MC Fernandes's Topo da Mente](https://www.pmcf.xyz/topo-da-mente/) +<<<<<<< HEAD If you want to see your own on here, submit a [Pull Request adding yourself to this file](https://github.com/jackyzha0/quartz/blob/v4/docs/showcase.md)! +======= +If you want to see your own on here, submit a [Pull Request adding yourself to this file](https://github.com/jackyzha0/quartz/blob/hugo/content/notes/showcase.md)! +>>>>>>> f95d4be1 (chore: migrate content)