From 24776624047bea380c51dbb503cdf335d37b83b0 Mon Sep 17 00:00:00 2001
From: Blake Allen <blake.edward.allen@gmail.com>
Date: Tue, 26 Oct 2021 19:46:03 +0000
Subject: [PATCH] Merge branch 'hugo' into hugo
---
/dev/null | 19 --
content/notes/hosting.md | 2
layouts/partials/search.html | 360 +++++++++++++++++++++++---------------------
content/moc/showcase.md | 1
assets/base.scss | 16 +
layouts/index.html | 2
content/notes/philosophy.md | 17 ++
content/notes/ignore-notes.md | 9 +
.github/workflows/deploy.yaml | 2
README.md | 4
content/_index.md | 35 +--
11 files changed, 246 insertions(+), 221 deletions(-)
diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml
index 2190194..b36c49c 100644
--- a/.github/workflows/deploy.yaml
+++ b/.github/workflows/deploy.yaml
@@ -12,7 +12,7 @@
- uses: actions/checkout@v2
- name: Build Link Index
- uses: jackyzha0/hugo-obsidian@v2.3
+ uses: jackyzha0/hugo-obsidian@v2.4
with:
index: true
input: content
diff --git a/README.md b/README.md
index 079e6c1..abcfb68 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# Quartz
-Simple second brain and digital garden.
+Host your own second brain and digital garden for free.
-> “He who works with the door open gets all kinds of interruptions, but he also occasionally gets clues as to what the world is and what might be important.” — Richard Hamming
+> “[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
🔗 Get Started: https://quartz.jzhao.xyz/
\ No newline at end of file
diff --git a/assets/base.scss b/assets/base.scss
index a1b5c7b..9811259 100644
--- a/assets/base.scss
+++ b/assets/base.scss
@@ -280,7 +280,8 @@
left: 0;
top: 0;
width: 100vw;
- height: 100vh;
+ height: 100%;
+ overflow: scroll;
display: none;
backdrop-filter: blur(4px);
-webkit-backdrop-filter: blur(4px);
@@ -324,7 +325,18 @@
border: 1px solid var(--outlinegray);
border-bottom: none;
- &:hover {
+ // normalize button props
+ font-family: inherit;
+ font-size: 100%;
+ line-height: 1.15;
+ margin: 0;
+ overflow: visible;
+ text-transform: none;
+ text-align: left;
+ background: var(--light);
+ outline: none;
+
+ &:hover, &:focus {
background: rgba(180, 180, 180, 0.15);
}
diff --git a/content/_index.md b/content/_index.md
index b665a3d..d981591 100644
--- a/content/_index.md
+++ b/content/_index.md
@@ -1,23 +1,18 @@
-# 🌱 Quartz
-## v2.0
-
-Simple second brain and [digital garden](https://jzhao.xyz/posts/digital-gardening).
-
-## 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*
-
-> “He who works with the door open gets all kinds of interruptions, but he also occasionally gets clues as to what the world is and what might be important.” — Richard Hamming
-
-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.
+---
+title: 🪴 Quartz v2.1
+---
+Host your second brain and [digital garden](https://jzhao.xyz/posts/digital-gardening) for free. Quartz features
+1. Extremely fast full-text search by pressing `/`
+2. Beautiful, out-of-the-box website creation and deployment
+3. Display for backlinks of each note
+4. A customizable graph view
+5. Endlessly powerful page and theme customization
## Get Started
-The entire Quartz documentation is fully hosted using Quartz! To get started, let's visit the main directory.
+> 📚 [Setup your own digital garden using Quartz](notes/setup.md)
-👉 [Directory](moc/directory.md)
\ No newline at end of file
+Not convinced yet? Look at some [community digital gardens](moc/showcase) built with Quartz, or read about [why I made Quartz](notes/philosophy.md) to begin with!
+
+## Troubleshooting
+- 🚧 [Troubleshooting and FAQ](notes/troubleshooting.md)
+- 🐛 [Submit an Issue](https://github.com/jackyzha0/quartz/issues)
\ No newline at end of file
diff --git a/content/moc/directory.md b/content/moc/directory.md
deleted file mode 100644
index b77f2ee..0000000
--- a/content/moc/directory.md
+++ /dev/null
@@ -1,19 +0,0 @@
----
-title: "Quartz Documentation"
----
-
-## Setup
-Welcome to Quartz! Whether you're setting up a website and project for the first time or a seasoned digital gardener, I hope that you'll find something useful about this project.
-
-Let's get to business and get you started!
-
-- 📚 [Setup your own digital garden using Quartz](notes/setup.md)
-- 🔗 [Linking with an Obsidian Vault](notes/obsidian.md)
-- 🎨 [Customizing and Styling Quartz](notes/config.md)
-- 🌍 [Hosting Quartz online!](notes/hosting.md)
-
-Not convinced yet? Look at some [community digital gardens](moc/showcase) built with Quartz!
-
-## Troubleshooting
-- 🚧 [Troubleshooting and FAQ](notes/troubleshooting.md)
-- 🐛 [Submit an Issue](https://github.com/jackyzha0/quartz/issues)
\ No newline at end of file
diff --git a/content/moc/showcase.md b/content/moc/showcase.md
index e1cb9a1..20e6a14 100644
--- a/content/moc/showcase.md
+++ b/content/moc/showcase.md
@@ -11,5 +11,6 @@
- [Shihyu's PKM](https://shihyuho.github.io/pkm/)
- [Chloe's Garden](https://garden.chloeabrasada.online/)
- [SlRvb's Site](https://slrvb.github.io/Site/)
+- [Course notes for Information Technology Advanced Theory](https://a2itnotes.github.io/quartz/)
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/moc/showcase.md)!
diff --git a/content/notes/hosting.md b/content/notes/hosting.md
index 7a5973c..c6027bb 100644
--- a/content/notes/hosting.md
+++ b/content/notes/hosting.md
@@ -80,6 +80,6 @@
Now that your Quartz is live, let's figure out how to make Quartz really *yours*!
-🎨 [Customizing Quarts](notes/config.md)
+🎨 [Customizing Quartz](notes/config.md)
Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).
\ No newline at end of file
diff --git a/content/notes/ignore-notes.md b/content/notes/ignore-notes.md
index 49bf5f3..e031421 100644
--- a/content/notes/ignore-notes.md
+++ b/content/notes/ignore-notes.md
@@ -15,6 +15,15 @@
```
`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).
diff --git a/content/notes/philosophy.md b/content/notes/philosophy.md
new file mode 100644
index 0000000..9325415
--- /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/layouts/index.html b/layouts/index.html
index 6f7725b..a234930 100644
--- a/layouts/index.html
+++ b/layouts/index.html
@@ -27,5 +27,5 @@
{{partial "footer.html" .}}
</div>
</body>
+</html>
-</html>
\ No newline at end of file
diff --git a/layouts/partials/search.html b/layouts/partials/search.html
index e2285ea..ce6038f 100644
--- a/layouts/partials/search.html
+++ b/layouts/partials/search.html
@@ -1,5 +1,5 @@
<div id="search-container">
- <div>
+ <div id="search-space">
<input autocomplete="off" id="search-bar" name="search" type="text" aria-label="Search" placeholder="Search for something...">
<div id="results-container">
</div>
@@ -7,202 +7,212 @@
</div>
<script src="https://cdn.jsdelivr.net/gh/nextapps-de/flexsearch@0.7.2/dist/flexsearch.bundle.js"></script>
<script>
- // code from https://github.com/danestves/markdown-to-text
- const removeMarkdown = (
- markdown,
- options = {
- listUnicodeChar: false,
- stripListLeaders: true,
- gfm: true,
- useImgAltText: false,
- preserveLinks: false,
- }
- ) => {
- let output = markdown || "";
- output = output.replace(/^(-\s*?|\*\s*?|_\s*?){3,}\s*$/gm, "");
+ // code from https://github.com/danestves/markdown-to-text
+ const removeMarkdown = (
+ markdown,
+ options = {
+ listUnicodeChar: false,
+ stripListLeaders: true,
+ gfm: true,
+ useImgAltText: false,
+ preserveLinks: false,
+ }
+ ) => {
+ let output = markdown || "";
+ output = output.replace(/^(-\s*?|\*\s*?|_\s*?){3,}\s*$/gm, "");
- try {
- if (options.stripListLeaders) {
- if (options.listUnicodeChar)
- output = output.replace(
- /^([\s\t]*)([\*\-\+]|\d+\.)\s+/gm,
- options.listUnicodeChar + " $1"
- );
- else output = output.replace(/^([\s\t]*)([\*\-\+]|\d+\.)\s+/gm, "$1");
- }
- if (options.gfm) {
- output = output
- .replace(/\n={2,}/g, "\n")
- .replace(/~{3}.*\n/g, "")
- .replace(/~~/g, "")
- .replace(/`{3}.*\n/g, "");
- }
- if(options.preserveLinks) {
- output = output.replace(/\[(.*?)\][\[\(](.*?)[\]\)]/g, "$1 ($2)")
- }
- output = output
- .replace(/<[^>]*>/g, "")
- .replace(/^[=\-]{2,}\s*$/g, "")
- .replace(/\[\^.+?\](\: .*?$)?/g, "")
- .replace(/\s{0,2}\[.*?\]: .*?$/g, "")
- .replace(/\!\[(.*?)\][\[\(].*?[\]\)]/g, options.useImgAltText ? "$1" : "")
- .replace(/\[(.*?)\][\[\(].*?[\]\)]/g, "$1")
- .replace(/^\s{0,3}>\s?/g, "")
- .replace(/(^|\n)\s{0,3}>\s?/g, "\n\n")
- .replace(/^\s{1,2}\[(.*?)\]: (\S+)( ".*?")?\s*$/g, "")
- .replace(
- /^(\n)?\s{0,}#{1,6}\s+| {0,}(\n)?\s{0,}#{0,} {0,}(\n)?\s{0,}$/gm,
- "$1$2$3"
- )
- .replace(/([\*_]{1,3})(\S.*?\S{0,1})\1/g, "$2")
- .replace(/([\*_]{1,3})(\S.*?\S{0,1})\1/g, "$2")
- .replace(/(`{3,})(.*?)\1/gm, "$2")
- .replace(/`(.+?)`/g, "$1")
- .replace(/\n{2,}/g, "\n\n");
- } catch (e) {
- console.error(e);
- return markdown;
- }
- return output;
- };
+ try {
+ if (options.stripListLeaders) {
+ if (options.listUnicodeChar)
+ output = output.replace(
+ /^([\s\t]*)([\*\-\+]|\d+\.)\s+/gm,
+ options.listUnicodeChar + " $1"
+ );
+ else output = output.replace(/^([\s\t]*)([\*\-\+]|\d+\.)\s+/gm, "$1");
+ }
+ if (options.gfm) {
+ output = output
+ .replace(/\n={2,}/g, "\n")
+ .replace(/~{3}.*\n/g, "")
+ .replace(/~~/g, "")
+ .replace(/`{3}.*\n/g, "");
+ }
+ if (options.preserveLinks) {
+ output = output.replace(/\[(.*?)\][\[\(](.*?)[\]\)]/g, "$1 ($2)")
+ }
+ output = output
+ .replace(/<[^>]*>/g, "")
+ .replace(/^[=\-]{2,}\s*$/g, "")
+ .replace(/\[\^.+?\](\: .*?$)?/g, "")
+ .replace(/\s{0,2}\[.*?\]: .*?$/g, "")
+ .replace(/\!\[(.*?)\][\[\(].*?[\]\)]/g, options.useImgAltText ? "$1" : "")
+ .replace(/\[(.*?)\][\[\(].*?[\]\)]/g, "$1")
+ .replace(/^\s{0,3}>\s?/g, "")
+ .replace(/(^|\n)\s{0,3}>\s?/g, "\n\n")
+ .replace(/^\s{1,2}\[(.*?)\]: (\S+)( ".*?")?\s*$/g, "")
+ .replace(
+ /^(\n)?\s{0,}#{1,6}\s+| {0,}(\n)?\s{0,}#{0,} {0,}(\n)?\s{0,}$/gm,
+ "$1$2$3"
+ )
+ .replace(/([\*_]{1,3})(\S.*?\S{0,1})\1/g, "$2")
+ .replace(/([\*_]{1,3})(\S.*?\S{0,1})\1/g, "$2")
+ .replace(/(`{3,})(.*?)\1/gm, "$2")
+ .replace(/`(.+?)`/g, "$1")
+ .replace(/\n{2,}/g, "\n\n");
+ } catch (e) {
+ console.error(e);
+ return markdown;
+ }
+ return output;
+ };
</script>
<script>
- const contentIndex = new FlexSearch.Worker({
- tokenize: "strict",
- charset: "latin:advanced",
- context: true,
- depth: 3,
- cache: 10,
- suggest: true,
- })
+ const contentIndex = new FlexSearch.Worker({
+ tokenize: "reverse",
+ charset: "latin:extra",
+ suggest: true,
+ cache: 10,
+ })
- const scrapedContent = {{$.Site.Data.contentIndex}}
- for (const [key, value] of Object.entries(scrapedContent)) {
- contentIndex.add(key, value.content)
- }
-
- const stopwords = ['i','me','my','myself','we','our','ours','ourselves','you','your','yours','yourself','yourselves','he','him','his','himself','she','her','hers','herself','it','its','itself','they','them','their','theirs','themselves','what','which','who','whom','this','that','these','those','am','is','are','was','were','be','been','being','have','has','had','having','do','does','did','doing','a','an','the','and','but','if','or','because','as','until','while','of','at','by','for','with','about','against','between','into','through','during','before','after','above','below','to','from','up','down','in','out','on','off','over','under','again','further','then','once','here','there','when','where','why','how','all','any','both','each','few','more','most','other','some','such','no','nor','not','only','own','same','so','than','too','very','s','t','can','will','just','don','should','now']
- const highlight = (content, term) => {
- const highlightWindow = 15
- const tokenizedTerm = term.split(/\s+/).filter(t => t !== "")
- const splitText = content.split(/\s+/).filter(t => t !== "")
- const includesCheck = (token) => tokenizedTerm.some(term => token.toLowerCase().includes(term.toLowerCase()))
-
- const occurrencesIndices = splitText
- .map(includesCheck)
-
- // calculate best index
- let bestSum = 0
- let bestIndex = 0
- for (let i = 0; i < Math.max(occurrencesIndices.length - highlightWindow, 0); i++) {
- const window = occurrencesIndices.slice(i, i + highlightWindow)
- const windowSum = window.reduce((total, cur) => total + cur, 0)
- if (windowSum > bestSum) {
- bestSum = windowSum
- bestIndex = i
- }
+ const scrapedContent = {{$.Site.Data.contentIndex}}
+ for (const [key, value] of Object.entries(scrapedContent)) {
+ contentIndex.add(key, value.content)
}
- const startIndex = Math.max(bestIndex - highlightWindow, 0)
- const endIndex = Math.min(startIndex + 2 * highlightWindow, splitText.length)
- const mappedText = splitText
- .slice(startIndex, endIndex)
- .map(token => {
- if (includesCheck(token)) {
- return `<span class="search-highlight">${token}</span>`
- }
- return token
- })
- .join(" ")
- .replaceAll('</span> <span class="search-highlight">', " ")
- return `${startIndex === 0 ? "" : "..."}${mappedText}${endIndex === splitText.length ? "" : "..."}`
- }
+ const highlight = (content, term) => {
+ const highlightWindow = 20
+ const tokenizedTerm = term.split(/\s+/).filter(t => t !== "")
+ const splitText = content.split(/\s+/).filter(t => t !== "")
+ const includesCheck = (token) => tokenizedTerm.some(term => token.toLowerCase().startsWith(term.toLowerCase()))
- const resultToHTML = ({url, title, content, term}) => {
- const md = content.split("---")[2]
- const text = removeMarkdown(md)
- const resultTitle = highlight(title, term)
- const resultText = highlight(text, term)
- return `<div class="result-card" id="${url}">
+ const occurrencesIndices = splitText
+ .map(includesCheck)
+
+ // calculate best index
+ let bestSum = 0
+ let bestIndex = 0
+ for (let i = 0; i < Math.max(occurrencesIndices.length - highlightWindow, 0); i++) {
+ const window = occurrencesIndices.slice(i, i + highlightWindow)
+ const windowSum = window.reduce((total, cur) => total + cur, 0)
+ if (windowSum >= bestSum) {
+ bestSum = windowSum
+ bestIndex = i
+ }
+ }
+
+ const startIndex = Math.max(bestIndex - highlightWindow, 0)
+ const endIndex = Math.min(startIndex + 2 * highlightWindow, splitText.length)
+ const mappedText = splitText
+ .slice(startIndex, endIndex)
+ .map(token => {
+ if (includesCheck(token)) {
+ return `<span class="search-highlight">${token}</span>`
+ }
+ return token
+ })
+ .join(" ")
+ .replaceAll('</span> <span class="search-highlight">', " ")
+ return `${startIndex === 0 ? "" : "..."}${mappedText}${endIndex === splitText.length ? "" : "..."}`
+ }
+
+ const resultToHTML = ({url, title, content, term}) => {
+ const text = removeMarkdown(content)
+ const resultTitle = highlight(title, term)
+ const resultText = highlight(text, term)
+ return `<button class="result-card" id="${url}">
<h3>${resultTitle}</h3>
<p>${resultText}</p>
- </div>`
- }
+ </button>`
+ }
- const source = document.getElementById('search-bar')
- const results = document.getElementById("results-container")
- source.addEventListener('input', (e) => {
- const term = e.target.value
- contentIndex.search(term, {
- limit: 5,
- depth: 3,
- suggest: true,
- }).then(searchResults => {
- const resultIds = [...new Set(searchResults)]
- const finalResults = resultIds.map(id => ({
- url: id,
- title: scrapedContent[id].title,
- content: scrapedContent[id].content
- }))
+ const redir = (id, term) => {
+ window.location.href = "{{.Site.BaseURL}}" + `${id}#:~:text=${encodeURIComponent(term)}`
+ }
- // display
- if (finalResults.length === 0) {
- results.innerHTML = `<div class="result-card">
+ const source = document.getElementById('search-bar')
+ const results = document.getElementById("results-container")
+ let term
+ source.addEventListener("keyup", (e) => {
+ if (e.key === "Enter") {
+ const anchor = document.getElementsByClassName("result-card")[0]
+ redir(anchor.id, term)
+ }
+ })
+ source.addEventListener('input', (e) => {
+ term = e.target.value
+ contentIndex.search(term, {
+ limit: 15,
+ suggest: true,
+ }).then(searchResults => {
+ const resultIds = [...new Set(searchResults)]
+ const finalResults = resultIds.map(id => ({
+ url: id,
+ title: scrapedContent[id].title,
+ content: scrapedContent[id].content
+ }))
+
+ // display
+ if (finalResults.length === 0) {
+ results.innerHTML = `<div class="result-card">
<p>No results.</p>
</div>`
- } else {
- results.innerHTML = finalResults
- .map(result => resultToHTML({
- ...result,
- term,
- }))
- .join("\n")
- const anchors = document.getElementsByClassName("result-card");
- [...anchors].forEach(anchor => {
- anchor.onclick = () => {
- window.location.href = `${anchor.id}#:~:text=${encodeURIComponent(term)}`
- }
+ } else {
+ results.innerHTML = finalResults
+ .map(result => resultToHTML({
+ ...result,
+ term,
+ }))
+ .join("\n")
+ const anchors = document.getElementsByClassName("result-card");
+ [...anchors].forEach(anchor => {
+ anchor.onclick = () => redir(anchor.id, term)
+ })
+ }
})
- }
})
- })
- const searchContainer = document.getElementById("search-container")
- function openSearch() {
- if (searchContainer.style.display === "none" || searchContainer.style.display === "") {
- source.value = ""
- results.innerHTML = ""
- searchContainer.style.display = "block"
- source.focus()
- } else {
- searchContainer.style.display = "none"
+ const searchContainer = document.getElementById("search-container")
+ function openSearch() {
+ if (searchContainer.style.display === "none" || searchContainer.style.display === "") {
+ source.value = ""
+ results.innerHTML = ""
+ searchContainer.style.display = "block"
+ source.focus()
+ } else {
+ searchContainer.style.display = "none"
+ }
}
- }
- function closeSearch() {
- searchContainer.style.display = "none"
- }
-
- document.addEventListener('keydown', (event) => {
- if (event.key === "/") {
- event.preventDefault()
- openSearch()
+ function closeSearch() {
+ searchContainer.style.display = "none"
}
- if (event.key === "Escape") {
- event.preventDefault()
- closeSearch()
- }
- })
- window.addEventListener('DOMContentLoaded', () => {
- const searchButton = document.getElementById("search-icon")
- searchButton.addEventListener('click', (evt) => {
- openSearch()
+ document.addEventListener('keydown', (event) => {
+ if (event.key === "/") {
+ event.preventDefault()
+ openSearch()
+ }
+ if (event.key === "Escape") {
+ event.preventDefault()
+ closeSearch()
+ }
})
- searchButton.addEventListener('keydown', (evt) => {
- openSearch()
+
+ window.addEventListener('DOMContentLoaded', () => {
+ const searchButton = document.getElementById("search-icon")
+ searchButton.addEventListener('click', (evt) => {
+ openSearch()
+ })
+ searchButton.addEventListener('keydown', (evt) => {
+ openSearch()
+ })
+ searchContainer.addEventListener('click', (evt) => {
+ closeSearch()
+ })
+ document.getElementById("search-space").addEventListener('click', (evt) => {
+ evt.stopPropagation()
+ })
})
- })
</script>
\ No newline at end of file
--
Gitblit v1.10.0