commit 6fb8a3368949d33f8f4f0da4eb4486c17cd2bdd9 Author: RΓ©mi Heredero <63239207+Klagarge@users.noreply.github.com> Date: Sun Apr 10 00:14:01 2022 +0200 Initial commit diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..40b2d4a --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +github: [jackyzha0] diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..189648d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Something about Quartz isn't working the way you expect +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..2c9c226 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea or improvement for Quartz +title: '' +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml new file mode 100644 index 0000000..6a22367 --- /dev/null +++ b/.github/workflows/deploy.yaml @@ -0,0 +1,37 @@ +name: Deploy to GitHub Pages + +on: + push: + branches: + - hugo + +jobs: + deploy: + runs-on: ubuntu-18.04 + steps: + - uses: actions/checkout@v2 + + - name: Build Link Index + uses: jackyzha0/hugo-obsidian@v2.12 + with: + index: true + input: content + output: assets/indices + root: . + + - name: Setup Hugo + uses: peaceiris/actions-hugo@v2 + with: + hugo-version: '0.96.0' + extended: true + + - name: Build + run: hugo --minify + + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./public + publish_branch: master # deploying branch + cname: quartz.jzhao.xyz diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a7ccdb5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +.DS_Store +public +resources +.idea +content/.obsidian +assets/indices/linkIndex.json +assets/indices/contentIndex.json diff --git a/.hugo_build.lock b/.hugo_build.lock new file mode 100644 index 0000000..e69de29 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..c624fd5 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,93 @@ +# Citizen Code of Conduct + +## 1. Purpose + +A primary goal of the Quartz community is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof). + +This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior. + +We invite all those who participate in the Quartz community to help us create safe and positive experiences for everyone. + +## 2. Open [Source/Culture/Tech] Citizenship + +A supplemental goal of this Code of Conduct is to increase open [source/culture/tech] citizenship by encouraging participants to recognize and strengthen the relationships between our actions and their effects on our community. + +Communities mirror the societies in which they exist and positive action is essential to counteract the many forms of inequality and abuses of power that exist in society. + +If you see someone who is making an extra effort to ensure our community is welcoming, friendly, and encourages all participants to contribute to the fullest extent, we want to know. + +## 3. Expected Behavior + +The following behaviors are expected and requested of all community members: + + * Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community. + * Exercise consideration and respect in your speech and actions. + * Attempt collaboration before conflict. + * Refrain from demeaning, discriminatory, or harassing behavior and speech. + * Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential. + * Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations. + +## 4. Unacceptable Behavior + +The following behaviors are considered harassment and are unacceptable within our community: + + * Violence, threats of violence or violent language directed against another person. + * Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language. + * Posting or displaying sexually explicit or violent material. + * Posting or threatening to post other people's personally identifying information ("doxing"). + * Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability. + * Inappropriate photography or recording. + * Inappropriate physical contact. You should have someone's consent before touching them. + * Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances. + * Deliberate intimidation, stalking or following (online or in person). + * Advocating for, or encouraging, any of the above behavior. + * Sustained disruption of community events, including talks and presentations. + +## 5. Weapons Policy + +No weapons will be allowed at Quartz community events, community spaces, or in other spaces covered by the scope of this Code of Conduct. Weapons include but are not limited to guns, explosives (including fireworks), and large knives such as those used for hunting or display, as well as any other item used for the purpose of causing injury or harm to others. Anyone seen in possession of one of these items will be asked to leave immediately, and will only be allowed to return without the weapon. Community members are further expected to comply with all state and local laws on this matter. + +## 6. Consequences of Unacceptable Behavior + +Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated. + +Anyone asked to stop unacceptable behavior is expected to comply immediately. + +If a community member engages in unacceptable behavior, the community organizers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning (and without refund in the case of a paid event). + +## 7. Reporting Guidelines + +If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. j.zhao2k19@gmail.com. + + + +Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe. In the context of in-person events, organizers will also provide escorts as desired by the person experiencing distress. + +## 8. Addressing Grievances + +If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify @jackyzha0 with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies. + + +## 9. Scope + +We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues--online and in-person--as well as in all one-on-one communications pertaining to community business. + +This code of conduct and its related procedures also applies to unacceptable behavior occurring outside the scope of community activities when such behavior has the potential to adversely affect the safety and well-being of community members. + +## 10. Contact info + +j.zhao2k19@gmail.com + +## 11. License and attribution + +The Citizen Code of Conduct is distributed by [Stumptown Syndicate](http://stumptownsyndicate.org) under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/). + +Portions of text derived from the [Django Code of Conduct](https://www.djangoproject.com/conduct/) and the [Geek Feminism Anti-Harassment Policy](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy). + +_Revision 2.3. Posted 6 March 2017._ + +_Revision 2.2. Posted 4 February 2016._ + +_Revision 2.1. Posted 23 June 2014._ + +_Revision 2.0, adopted by the [Stumptown Syndicate](http://stumptownsyndicate.org) board on 10 January 2013. Posted 17 March 2013._ diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..147e2ca --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 jackyzha0 + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..9beee0f --- /dev/null +++ b/Makefile @@ -0,0 +1,18 @@ +.DEFAULT_GOAL := serve + +help: ## Show all Makefile targets + @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' + +update: ## Update Quartz to the latest version on Github + @git remote show upstream || (echo "remote 'upstream' not present, setting 'upstream'" && git remote add upstream https://github.com/jackyzha0/quartz.git) + git fetch upstream + git log --oneline --decorate --graph ..upstream/hugo + git checkout -p upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss config.toml data + +update-force: ## Forcefully pull all changes and don't ask to patch + @git remote show upstream || (echo "remote 'upstream' not present, setting 'upstream'" && git remote add upstream https://github.com/jackyzha0/quartz.git) + git fetch upstream + git checkout upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss config.toml data + +serve: ## Serve Quartz locally + hugo-obsidian -input=content -output=assets/indices -index -root=. && hugo server --enableGitInfo diff --git a/README.md b/README.md new file mode 100644 index 0000000..125514a --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# Quartz + +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 `Ctrl` + `k` +2. Customizable and hackable design based on Hugo +3. Automatically generated backlinks, link previews, and local graph +4. Built-in CJK + Latex Support +5. Support for both Markdown Links and Wikilinks + +> β€œ[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/ + +![Quartz Example Screenshot](./screenshot.png)*Quartz Example Screenshot* + +[Join the Discord Community](https://discord.gg/cRFFHYye7t) diff --git a/assets/indices/.gitkeep b/assets/indices/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/assets/js/darkmode.js b/assets/js/darkmode.js new file mode 100644 index 0000000..d95a281 --- /dev/null +++ b/assets/js/darkmode.js @@ -0,0 +1,29 @@ +const userPref = window.matchMedia('(prefers-color-scheme: light)').matches ? 'light' : 'dark' +const currentTheme = localStorage.getItem('theme') ?? userPref + +if (currentTheme) { + document.documentElement.setAttribute('saved-theme', currentTheme); +} + +const switchTheme = (e) => { + if (e.target.checked) { + document.documentElement.setAttribute('saved-theme', 'dark') + localStorage.setItem('theme', 'dark') + } + else { + document.documentElement.setAttribute('saved-theme', 'light') + localStorage.setItem('theme', 'light') + } +} + +window.addEventListener('DOMContentLoaded', () => { + // Darkmode toggle + const toggleSwitch = document.querySelector('#darkmode-toggle') + + // listen for toggle + toggleSwitch.addEventListener('change', switchTheme, false) + + if (currentTheme === 'dark') { + toggleSwitch.checked = true + } +}) diff --git a/assets/js/graph.js b/assets/js/graph.js new file mode 100644 index 0000000..f0b1f7f --- /dev/null +++ b/assets/js/graph.js @@ -0,0 +1,220 @@ +async function drawGraph(url, baseUrl, pathColors, depth, enableDrag, enableLegend, enableZoom) { + const { index, links, content } = await fetchData + const curPage = url.replace(baseUrl, "") + + const parseIdsFromLinks = (links) => [...(new Set(links.flatMap(link => ([link.source, link.target]))))] + + const neighbours = new Set() + const wl = [curPage || "/", "__SENTINEL"] + if (depth >= 0) { + while (depth >= 0 && wl.length > 0) { + // compute neighbours + const cur = wl.shift() + if (cur === "__SENTINEL") { + depth-- + wl.push("__SENTINEL") + } else { + neighbours.add(cur) + const outgoing = index.links[cur] || [] + const incoming = index.backlinks[cur] || [] + wl.push(...outgoing.map(l => l.target), ...incoming.map(l => l.source)) + } + } + } else { + parseIdsFromLinks(links).forEach(id => neighbours.add(id)) + } + + const data = { + nodes: [...neighbours].map(id => ({ id })), + links: links.filter(l => neighbours.has(l.source) && neighbours.has(l.target)), + } + + const color = (d) => { + if (d.id === curPage || (d.id === "/" && curPage === "")) { + return "var(--g-node-active)" + } + + for (const pathColor of pathColors) { + const path = Object.keys(pathColor)[0] + const colour = pathColor[path] + if (d.id.startsWith(path)) { + return colour + } + } + + return "var(--g-node)" + } + + const drag = simulation => { + function dragstarted(event, d) { + if (!event.active) simulation.alphaTarget(1).restart(); + d.fx = d.x; + d.fy = d.y; + } + + function dragged(event, d) { + d.fx = event.x; + d.fy = event.y; + } + + function dragended(event, d) { + if (!event.active) simulation.alphaTarget(0); + d.fx = null; + d.fy = null; + } + + const noop = () => { } + return d3.drag() + .on("start", enableDrag ? dragstarted : noop) + .on("drag", enableDrag ? dragged : noop) + .on("end", enableDrag ? dragended : noop); + } + + const height = 250 + const width = document.getElementById("graph-container").offsetWidth + + const simulation = d3.forceSimulation(data.nodes) + .force("charge", d3.forceManyBody().strength(-30)) + .force("link", d3.forceLink(data.links).id(d => d.id)) + .force("center", d3.forceCenter()); + + const svg = d3.select('#graph-container') + .append('svg') + .attr('width', width) + .attr('height', height) + .attr("viewBox", [-width / 2, -height / 2, width, height]); + + if (enableLegend) { + const legend = [ + { "Current": "var(--g-node-active)" }, + { "Note": "var(--g-node)" }, + ...pathColors + ] + legend.forEach((legendEntry, i) => { + const key = Object.keys(legendEntry)[0] + const colour = legendEntry[key] + svg.append("circle").attr("cx", -width / 2 + 20).attr("cy", height / 2 - 30 * (i + 1)).attr("r", 6).style("fill", colour) + svg.append("text").attr("x", -width / 2 + 40).attr("y", height / 2 - 30 * (i + 1)).text(key).style("font-size", "15px").attr("alignment-baseline", "middle") + }) + } + + // draw links between nodes + const link = svg.append("g") + .selectAll("line") + .data(data.links) + .join("line") + .attr("class", "link") + .attr("stroke", "var(--g-link)") + .attr("stroke-width", 2) + .attr("data-source", d => d.source.id) + .attr("data-target", d => d.target.id) + + // svg groups + const graphNode = svg.append("g") + .selectAll("g") + .data(data.nodes) + .enter().append("g") + + // draw individual nodes + const node = graphNode.append("circle") + .attr("class", "node") + .attr("id", (d) => d.id) + .attr("r", (d) => { + const numOut = index.links[d.id]?.length || 0 + const numIn = index.backlinks[d.id]?.length || 0 + return 3 + (numOut + numIn) / 4 + }) + .attr("fill", color) + .style("cursor", "pointer") + .on("click", (_, d) => { + window.location.href = baseUrl + '/' + decodeURI(d.id).replace(/\s+/g, '-') + }) + .on("mouseover", function(_, d) { + d3.selectAll(".node") + .transition() + .duration(100) + .attr("fill", "var(--g-node-inactive)") + + const neighbours = parseIdsFromLinks([...(index.links[d.id] || []), ...(index.backlinks[d.id] || [])]) + const neighbourNodes = d3.selectAll(".node").filter(d => neighbours.includes(d.id)) + const currentId = d.id + const linkNodes = d3.selectAll(".link").filter(d => d.source.id === currentId || d.target.id === currentId) + + // highlight neighbour nodes + neighbourNodes + .transition() + .duration(200) + .attr("fill", color) + + // highlight links + linkNodes + .transition() + .duration(200) + .attr("stroke", "var(--g-link-active)") + + // show text for self + d3.select(this.parentNode) + .select("text") + .raise() + .transition() + .duration(200) + .style("opacity", 1) + }).on("mouseleave", function(_, d) { + d3.selectAll(".node") + .transition() + .duration(200) + .attr("fill", color) + + const currentId = d.id + const linkNodes = d3.selectAll(".link").filter(d => d.source.id === currentId || d.target.id === currentId) + + linkNodes + .transition() + .duration(200) + .attr("stroke", "var(--g-link)") + + d3.select(this.parentNode) + .select("text") + .transition() + .duration(200) + .style("opacity", 0) + }) + .call(drag(simulation)); + + // draw labels + const labels = graphNode.append("text") + .attr("dx", 12) + .attr("dy", ".35em") + .text((d) => content[d.id]?.title || d.id.replace("-", " ")) + .style("opacity", 0) + .style("pointer-events", "none") + .call(drag(simulation)); + + // set panning + + if (enableZoom) { + svg.call(d3.zoom() + .extent([[0, 0], [width, height]]) + .scaleExtent([0.25, 4]) + .on("zoom", ({ transform }) => { + link.attr("transform", transform); + node.attr("transform", transform); + labels.attr("transform", transform); + })); + } + + // progress the simulation + simulation.on("tick", () => { + link + .attr("x1", d => d.source.x) + .attr("y1", d => d.source.y) + .attr("x2", d => d.target.x) + .attr("y2", d => d.target.y) + node + .attr("cx", d => d.x) + .attr("cy", d => d.y) + labels + .attr("x", d => d.x) + .attr("y", d => d.y) + }); +} diff --git a/assets/js/popover.js b/assets/js/popover.js new file mode 100644 index 0000000..a4b6852 --- /dev/null +++ b/assets/js/popover.js @@ -0,0 +1,35 @@ +function htmlToElement(html) { + const template = document.createElement('template') + html = html.trim() + template.innerHTML = html + return template.content.firstChild +} + +function initPopover(baseURL) { + const basePath = baseURL.replace(window.location.origin, "") + document.addEventListener("DOMContentLoaded", () => { + fetchData.then(({ content }) => { + const links = [...document.getElementsByClassName("internal-link")] + links + .filter(li => li.dataset.src) + .forEach(li => { + const linkDest = content[li.dataset.src.replace(basePath, "")] + if (linkDest) { + const popoverElement = `
+

${linkDest.title}

+

${removeMarkdown(linkDest.content).split(" ", 20).join(" ")}...

+

${new Date(linkDest.lastmodified).toLocaleDateString()}

+
` + const el = htmlToElement(popoverElement) + li.appendChild(el) + li.addEventListener("mouseover", () => { + el.classList.add("visible") + }) + li.addEventListener("mouseout", () => { + el.classList.remove("visible") + }) + } + }) + }) + }) +} diff --git a/assets/js/search.js b/assets/js/search.js new file mode 100644 index 0000000..facebe5 --- /dev/null +++ b/assets/js/search.js @@ -0,0 +1,239 @@ +// 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; +}; +// ----- + +(async function() { + const encoder = str => str.toLowerCase().split(/([^a-z]|[^\x00-\x7F])+/) + const contentIndex = new FlexSearch.Document({ + cache: true, + charset: "latin:extra", + optimize: true, + index: [{ + field: "content", + tokenize: "reverse", + encode: encoder, + }, { + field: "title", + tokenize: "forward", + encode: encoder, + }] + }) + + const { content } = await fetchData + for (const [key, value] of Object.entries(content)) { + contentIndex.add({ + id: key, + title: value.title, + content: removeMarkdown(value.content), + }) + } + + 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 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 `${token}` + } + return token + }) + .join(" ") + .replaceAll(' ', " ") + 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 `` + } + + const redir = (id, term) => { + window.location.href = BASE_URL + `${id}#:~:text=${encodeURIComponent(term)}` + } + + const formatForDisplay = id => ({ + id, + url: id, + title: content[id].title, + content: content[id].content + }) + + 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 + const searchResults = contentIndex.search(term, [ + { + field: "content", + limit: 10, + }, + { + field: "title", + limit: 5, + } + ]) + const getByField = field => { + const results = searchResults.filter(x => x.field === field) + if (results.length === 0) { + return [] + } else { + return [...results[0].result] + } + } + const allIds = new Set([...getByField('title'), ...getByField('content')]) + const finalResults = [...allIds].map(formatForDisplay) + + // display + if (finalResults.length === 0) { + results.innerHTML = `` + } 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" + } + } + + function closeSearch() { + searchContainer.style.display = "none" + } + + document.addEventListener('keydown', (event) => { + if (event.key === "k" && (event.ctrlKey || event.metaKey)) { + event.preventDefault() + openSearch() + } + if (event.key === "Escape") { + event.preventDefault() + closeSearch() + } + }) + + 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() + }) +})() + diff --git a/assets/styles/base.scss b/assets/styles/base.scss new file mode 100644 index 0000000..1be0229 --- /dev/null +++ b/assets/styles/base.scss @@ -0,0 +1,571 @@ +:root { + --lt-colours-light: var(--light) !important; + --lt-colours-lightgray: var(--lightgray) !important; + --lt-colours-dark: var(--secondary) !important; + --lt-colours-secondary: var(--tertiary) !important; + --lt-colours-gray: var(--outlinegray) !important; +} + +h1, h2, h3, h4, h5, h6, ol, ul, thead { + font-family: Inter; + color: var(--dark); + font-weight: revert; + margin: revert; + padding: revert; +} + +p, ul, text { + font-family: 'Source Sans Pro', sans-serif; + color: var(--gray); + fill: var(--gray); + font-weight: revert; + margin: revert; + padding: revert; +} + +.mainTOC { + background: var(--lightgray); + border-radius: 5px; + padding: 0.75em 1em; +} + +.mainTOC details summary { + cursor: zoom-in; + font-family: Inter; + color: var(--dark); + font-weight: 700; +} + +.mainTOC details[open] summary { + cursor: zoom-out; +} + +#TableOfContents > ol { + counter-reset: section; + margin-left: 0em; + padding-left: 1.5em; + & > li { + counter-increment: section; + & > ol { + counter-reset: subsection; + & > li { + counter-increment: subsection; + &::marker { + content: counter(section) "." counter(subsection) " "; + } + } + } + } + + & > li::marker { + content: counter(section) " "; + } + + & > li::marker, & > li > ol > li::marker { + font-family: Source Sans Pro; + font-weight: 700; + } +} + +table { + width: 100%; +} + +img { + width: 100%; + border-radius: 3px; + margin: 1em 0; +} + +p>img+em { + display: block; + transform: translateY(-1em); +} + +sup { + line-height: 0 +} + +p, tbody, li { + font-family: Source Sans Pro; + color: var(--gray); + line-height: 1.5em; +} + +blockquote { + margin-left: 0em; + border-left: 3px solid var(--secondary); + padding-left: 1em; + transition: border-color 0.2s ease; + + &:hover { + border-color: var(--tertiary); + } +} + +table { + padding: 1.5em; +} + +td, th { + padding: 0.1em 0.5em; +} + +.footnotes p { + margin: 0.5em 0; +} + +.pagination { + list-style: none; + padding-left: 0; + display: flex; + margin-top: 2em; + gap: 1.5em; + justify-content: center; + + .disabled { + opacity: 0.2; + } + + & > li { + text-align: center; + display: inline-block; + + & a { + background-color: transparent !important; + } + + & a[href$="#"] { + opacity: 0.2; + } + } +} + +.section { + & h3 > a { + font-weight: 700; + font-family: Inter; + margin: 0; + } + & p { + margin-top: 0; + } +} + +article { + & > .meta { + margin: -1.5em 0 1em 0; + opacity: 0.7; + } + + & > .tags { + list-style: none; + padding-left: 0; + + & .meta { + & > h1 { + margin: 0; + } + & > p { + margin: 0; + } + } + + & > li { + display: inline-block; + } + & > li > a { + border-radius: 8px; + border: var(--outlinegray) 1px solid; + padding: 0.2em 0.5em; + &::before { + content: "#"; + margin-right: 0.3em; + color: var(--outlinegray); + } + } + } + + & a { + font-family: Source Sans Pro; + font-weight: 600; + + &.internal-link { + text-decoration: none; + background-color: transparentize(#8f9fa9, 0.85); + padding: 0 0.1em; + margin: auto -0.1em; + border-radius: 3px; + + &.broken { + opacity: 0.5; + background-color: transparent; + } + } + } + + & p { + overflow-wrap: anywhere; + } +} + +.backlinks a { + font-weight: 600; + font-size: 0.9rem; +} + +sup > a { + text-decoration: none; + padding: 0 0.1em 0 0.2em; +} + +a { + font-family: Inter, sans-serif; + font-size: 1em; + font-weight: 700; + text-decoration: none; + transition: all 0.2s ease; + color: var(--secondary); + + &:hover { + color: var(--tertiary) !important; + } +} + +pre { + font-family: 'Fira Code'; + padding: 0.75em; + border-radius: 3px; + overflow-x: scroll; +} + +code { + font-family: 'Fira Code'; + font-size: 0.85em; + padding: 0.15em 0.3em; + border-radius: 5px; + background: var(--lightgray); +} + +html { + scroll-behavior: smooth; + + &:lang(ar) { + & p, & h1, & h2, & h3, article { + direction: rtl; + text-align: right; + } + } +} + +body { + margin: 0; + height: 100vh; + width: 100vw; + //overflow-x: hidden; + max-width: 100%; + box-sizing: border-box; + background-color: var(--light); +} + +@keyframes fadeIn { + 0% {opacity:0;} + 100% {opacity:1;} +} + +footer { + margin-top: 4em; + text-align: center; + & ul { + padding-left: 0; + } +} + +hr { + width: 25%; + margin: 4em auto; + height: 2px; + border-radius: 1px; + border-width: 0; + color: var(--dark); + background-color: var(--dark); +} + +.singlePage { + padding: 4em 30vw; + + @media all and (max-width: 1200px) { + padding: 25px 5vw; + } +} + +.page-end { + display: flex; + flex-direction: row; + gap: 2em; + + @media all and (max-width: 780px) { + flex-direction: column; + } + + & > * { + flex: 1 0 0; + } + + & > .backlinks-container { + & > ul { + list-style: none; + padding-left: 0; + + & > li { + margin: 0.5em 0; + padding: 0.25em 1em; + border: var(--outlinegray) 1px solid; + border-radius: 5px + } + } + } + + & #graph-container { + border: var(--outlinegray) 1px solid; + border-radius: 5px; + } +} + +.centered { + margin-top: 30vh; +} + +article > h1 { + font-size: 2em; +} + +header { + display: flex; + flex-direction: row; + align-items: center; + + & > h1 { + font-size: 2em; + } + + & > nav { + @media all and (max-width: 600px) { + display: none; + } + } + + & > .spacer { + flex: 1 1 auto; + } + + & > svg { + cursor: pointer; + width: 18px; + min-width: 18px; + margin: 0 1em; + + &:hover .search-path { + stroke: var(--tertiary); + } + + .search-path { + stroke: var(--gray); + stroke-width: 2px; + transition: stroke 0.5s ease; + } + } +} + +#search-container { + position: fixed; + z-index: 9999; + left: 0; + top: 0; + width: 100vw; + height: 100%; + overflow: scroll; + display: none; + backdrop-filter: blur(4px); + -webkit-backdrop-filter: blur(4px); + + & > div { + width: 50%; + margin-top: 15vh; + margin-left: auto; + margin-right: auto; + + @media all and (max-width: 1200px) { + width: 90%; + } + + & > * { + width: 100%; + border-radius: 4px; + background: var(--light); + box-shadow: 0 14px 50px rgba(27, 33, 48, 0.12), 0 10px 30px rgba(27, 33, 48, 0.16); + margin-bottom: 2em; + } + + & > input { + box-sizing: border-box; + padding: 0.5em 1em; + font-family: Inter, sans-serif; + color: var(--dark); + font-size: 1.1em; + border: 1px solid var(--outlinegray); + + &:focus { + outline: none; + } + } + + & > #results-container { + & > .result-card { + padding: 1em; + cursor: pointer; + transition: background 0.2s ease; + border: 1px solid var(--outlinegray); + border-bottom: none; + width: 100%; + + // 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); + } + + &:first-of-type { + border-top-left-radius: 5px; + border-top-right-radius: 5px; + } + + &:last-of-type { + border-bottom-left-radius: 5px; + border-bottom-right-radius: 5px; + border-bottom: 1px solid var(--outlinegray); + } + + & > h3, & > p { + margin: 0; + } + + & .search-highlight { + background-color: #afbfc966; + padding: 0.05em 0.2em; + border-radius: 3px; + } + } + } + } +} + +.section-ul { + list-style: none; + padding-left: 0; + + & > li { + border: 1px solid var(--outlinegray); + border-radius: 5px; + padding: 0 1em; + margin-bottom: 1em; + + & h3 { + opacity: 1; + font-weight: 700; + margin-bottom: 0em; + } + + & .meta { + opacity: 0.6; + } + } +} + +@keyframes dropin { + 0% { + display: none; + opacity: 0; + visibility: hidden; + } + 1% { + display: inline-block; + opacity: 0; + transform: translate(-50%, 40%); + } + 100% { + opacity: 1; + visibility: visible; + transform: translate(-50%, 20%); + } +} + +.popover { + z-index: 999; + position: absolute; + width: 20em; + display: none; + background-color: var(--light); + padding: 1em; + border: 1px solid var(--outlinegray); + border-radius: 5px; + transform: translate(-50%, 40%); + pointer-events: none; + transition: opacity 0.2s ease, transform 0.2s ease; + user-select: none; + overflow-wrap: anywhere; + box-shadow: 6px 6px 36px 0px rgba(0,0,0,0.25); + + @media all and (max-width: 600px) { + display: none; + } + + &.visible { + opacity: 1; + visibility: visible; + transform: translate(-50%, 20%); + display: inline-block; + animation: dropin 0.2s ease; + } + + & > h3 { + font-size: 1rem; + margin: 0.25em 0; + } + + & > .meta { + margin-top: 0.25em; + opacity: 0.5; + font-family: "JetBrains Mono", monospace; + font-size: 0.8rem; + } + + & > p { + margin: 0; + font-weight: 400; + user-select: none; + } +} + + + +#contact_buttons ul { + list-style-type: none; + + li { + display: inline-block; + } + + li a { + padding: 0 1em; + } +} diff --git a/assets/styles/custom.scss b/assets/styles/custom.scss new file mode 100644 index 0000000..612b80a --- /dev/null +++ b/assets/styles/custom.scss @@ -0,0 +1,24 @@ +// Add your own CSS here! +:root { + --light: #faf8f8; + --dark: #141021; + --secondary: #284b63; + --tertiary: #84a59d; + --visited: #afbfc9; + --primary: #f28482; + --gray: #4e4e4e; + --lightgray: #f0f0f0; + --outlinegray: #dadada; +} + +[saved-theme="dark"] { + --light: #1e1e21 !important; + --dark: #fbfffe !important; + --secondary: #6b879a !important; + --visited: #4a575e !important; + --tertiary: #84a59d !important; + --primary: #f58382 !important; + --gray: #d4d4d4 !important; + --lightgray: #292633 !important; + --outlinegray: #343434 !important; +} \ No newline at end of file diff --git a/assets/styles/darkmode.scss b/assets/styles/darkmode.scss new file mode 100644 index 0000000..61967d7 --- /dev/null +++ b/assets/styles/darkmode.scss @@ -0,0 +1,44 @@ +.darkmode { + float: right; + padding: 1em; + min-width: 30px; + position: relative; + + @media all and (max-width: 450px) { + padding: 1em; + } + + & > .toggle { + display: none; + box-sizing: border-box; + } + + & svg { + opacity: 0; + position: absolute; + width: 20px; + height: 20px; + top: calc(50% - 10px); + margin: 0 7px; + fill: var(--gray); + transition: opacity 0.1s ease; + } +} + +.toggle:checked ~ label { + & > #dayIcon { + opacity: 0; + } + & > #nightIcon { + opacity: 1; + } +} + +.toggle:not(:checked) ~ label { + & > #dayIcon { + opacity: 1; + } + & > #nightIcon { + opacity: 0; + } +} \ No newline at end of file diff --git a/assets/styles/syntax.scss b/assets/styles/syntax.scss new file mode 100644 index 0000000..bada47a --- /dev/null +++ b/assets/styles/syntax.scss @@ -0,0 +1,99 @@ +/* Background */ .chroma { color: #f8f8f2; background-color: #282a36; overflow: hidden } +/* Other */ .chroma .x { } +/* Error */ .chroma .err { } +/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; } +/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; width: auto; overflow: auto; display: block; } +/* LineHighlight */ .chroma .hl { display: block; width: 100%;background-color: #ffffcc } +/* LineNumbersTable */ .chroma .lnt { margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f } +/* LineNumbers */ .chroma .ln { margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f } +/* Keyword */ .chroma .k { color: #ff79c6 } +/* KeywordConstant */ .chroma .kc { color: #ff79c6 } +/* KeywordDeclaration */ .chroma .kd { color: #8be9fd; font-style: italic } +/* KeywordNamespace */ .chroma .kn { color: #ff79c6 } +/* KeywordPseudo */ .chroma .kp { color: #ff79c6 } +/* KeywordReserved */ .chroma .kr { color: #ff79c6 } +/* KeywordType */ .chroma .kt { color: #8be9fd } +/* Name */ .chroma .n { } +/* NameAttribute */ .chroma .na { color: #50fa7b } +/* NameBuiltin */ .chroma .nb { color: #8be9fd; font-style: italic } +/* NameBuiltinPseudo */ .chroma .bp { } +/* NameClass */ .chroma .nc { color: #50fa7b } +/* NameConstant */ .chroma .no { } +/* NameDecorator */ .chroma .nd { } +/* NameEntity */ .chroma .ni { } +/* NameException */ .chroma .ne { } +/* NameFunction */ .chroma .nf { color: #50fa7b } +/* NameFunctionMagic */ .chroma .fm { } +/* NameLabel */ .chroma .nl { color: #8be9fd; font-style: italic } +/* NameNamespace */ .chroma .nn { } +/* NameOther */ .chroma .nx { } +/* NameProperty */ .chroma .py { } +/* NameTag */ .chroma .nt { color: #ff79c6 } +/* NameVariable */ .chroma .nv { color: #8be9fd; font-style: italic } +/* NameVariableClass */ .chroma .vc { color: #8be9fd; font-style: italic } +/* NameVariableGlobal */ .chroma .vg { color: #8be9fd; font-style: italic } +/* NameVariableInstance */ .chroma .vi { color: #8be9fd; font-style: italic } +/* NameVariableMagic */ .chroma .vm { } +/* Literal */ .chroma .l { } +/* LiteralDate */ .chroma .ld { } +/* LiteralString */ .chroma .s { color: #f1fa8c } +/* LiteralStringAffix */ .chroma .sa { color: #f1fa8c } +/* LiteralStringBacktick */ .chroma .sb { color: #f1fa8c } +/* LiteralStringChar */ .chroma .sc { color: #f1fa8c } +/* LiteralStringDelimiter */ .chroma .dl { color: #f1fa8c } +/* LiteralStringDoc */ .chroma .sd { color: #f1fa8c } +/* LiteralStringDouble */ .chroma .s2 { color: #f1fa8c } +/* LiteralStringEscape */ .chroma .se { color: #f1fa8c } +/* LiteralStringHeredoc */ .chroma .sh { color: #f1fa8c } +/* LiteralStringInterpol */ .chroma .si { color: #f1fa8c } +/* LiteralStringOther */ .chroma .sx { color: #f1fa8c } +/* LiteralStringRegex */ .chroma .sr { color: #f1fa8c } +/* LiteralStringSingle */ .chroma .s1 { color: #f1fa8c } +/* LiteralStringSymbol */ .chroma .ss { color: #f1fa8c } +/* LiteralNumber */ .chroma .m { color: #bd93f9 } +/* LiteralNumberBin */ .chroma .mb { color: #bd93f9 } +/* LiteralNumberFloat */ .chroma .mf { color: #bd93f9 } +/* LiteralNumberHex */ .chroma .mh { color: #bd93f9 } +/* LiteralNumberInteger */ .chroma .mi { color: #bd93f9 } +/* LiteralNumberIntegerLong */ .chroma .il { color: #bd93f9 } +/* LiteralNumberOct */ .chroma .mo { color: #bd93f9 } +/* Operator */ .chroma .o { color: #ff79c6 } +/* OperatorWord */ .chroma .ow { color: #ff79c6 } +/* Punctuation */ .chroma .p { } +/* Comment */ .chroma .c { color: #6272a4 } +/* CommentHashbang */ .chroma .ch { color: #6272a4 } +/* CommentMultiline */ .chroma .cm { color: #6272a4 } +/* CommentSingle */ .chroma .c1 { color: #6272a4 } +/* CommentSpecial */ .chroma .cs { color: #6272a4 } +/* CommentPreproc */ .chroma .cp { color: #ff79c6 } +/* CommentPreprocFile */ .chroma .cpf { color: #ff79c6 } +/* Generic */ .chroma .g { } +/* GenericDeleted */ .chroma .gd { color: #8b080b } +/* GenericEmph */ .chroma .ge { text-decoration: underline } +/* GenericError */ .chroma .gr { } +/* GenericHeading */ .chroma .gh { font-weight: bold } +/* GenericInserted */ .chroma .gi { font-weight: bold } +/* GenericOutput */ .chroma .go { color: #44475a } +/* GenericPrompt */ .chroma .gp { } +/* GenericStrong */ .chroma .gs { } +/* GenericSubheading */ .chroma .gu { font-weight: bold } +/* GenericTraceback */ .chroma .gt { } +/* GenericUnderline */ .chroma .gl { text-decoration: underline } +/* TextWhitespace */ .chroma .w { } + +.lntd:first-of-type > .chroma { + padding-right: 0; +} + +.chroma code { + font-family: 'Fira Code' !important; + font-size: 0.85em; + line-height: 1em; + background: none; + padding: 0; +} + +.chroma { + border-radius: 3px; + margin: 0; +} \ No newline at end of file diff --git a/config.toml b/config.toml new file mode 100644 index 0000000..5c4dfcb --- /dev/null +++ b/config.toml @@ -0,0 +1,30 @@ +baseURL = "https://quartz.jzhao.xyz/" +languageCode = "en-us" +googleAnalytics = "G-XYFD95KB4J" +pygmentsUseClasses = true +relativeURLs = false +disablePathToLower = true +ignoreFiles = [ + "/content/templates/*", + "/content/private/*", +] +summaryLength = 20 +paginate = 10 +enableGitInfo = true + +[markup] + [markup.tableOfContents] + endLevel = 3 + ordered = true + startLevel = 2 + [markup.highlight] + anchorLineNos = false + codeFences = true + guessSyntax = true + hl_Lines = "" + lineAnchors = "" + lineNoStart = 1 + lineNos = true + lineNumbersInTable = true + style = "dracula" + tabWidth = 4 diff --git a/content/_index.md b/content/_index.md new file mode 100644 index 0000000..bd742c4 --- /dev/null +++ b/content/_index.md @@ -0,0 +1,27 @@ +--- +title: πŸͺ΄ Quartz 3.2 +--- + +Host your second brain and [digital garden](https://jzhao.xyz/posts/networked-thought) for free. Quartz features + +1. Extremely fast full-text search by pressing `Ctrl` + `k` +2. Customizable and hackable design based on Hugo +3. Automatically generated backlinks, link previews, and local graph +4. Built-in [[notes/CJK + Latex Support (ζ΅‹θ―•) | CJK + Latex Support]] +5. Support for both Markdown Links and Wikilinks + +## Get Started +> πŸ“š [Setup your own digital garden using Quartz](notes/setup.md) + +Not convinced yet? Look at some [community digital gardens](notes/showcase.md) built with Quartz, or read about [why I made Quartz](notes/philosophy.md) to begin with. + +## Content Lists +If you prefer browsing the contents of this site through a list instead of a graph, you can find content lists here too: + +- [All Notes](/notes) +- [Setup-related Notes](/tags/setup) + +## Troubleshooting +- 🚧 [Troubleshooting and FAQ](notes/troubleshooting.md) +- πŸ› [Submit an Issue](https://github.com/jackyzha0/quartz/issues) +- πŸ‘€ [Discord Community](https://discord.gg/cRFFHYye7t) diff --git a/content/notes/CJK + Latex Support (ζ΅‹θ―•).md b/content/notes/CJK + Latex Support (ζ΅‹θ―•).md new file mode 100644 index 0000000..d6e4ae9 --- /dev/null +++ b/content/notes/CJK + Latex Support (ζ΅‹θ―•).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} = 0$ + +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/config.md b/content/notes/config.md new file mode 100644 index 0000000..d04b152 --- /dev/null +++ b/content/notes/config.md @@ -0,0 +1,67 @@ +--- +title: "Configuration" +tags: +- setup +--- + +## 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 be found under `data/config.yaml`. An annotated example configuration is shown below. + +```yaml +name: Your name here! # Shows in the footer +enableToc: true # Whether to show a Table of Contents +enableLinkPreview: true # whether to render card previews for links +description: Page description to show to search engines +page_title: Quartz Example Page # Default Page Title + +links: # Links to show in footer + - link_name: Twitter + link: https://twitter.com/_jzhao + - link_name: Github + link: https://github.com/jackyzha0 +``` + +### Graph View +To customize the Interactive Graph view, you can poke around `data/graphConfig.yaml`. + +```yaml +enableLegend: false # automatically generate a legend +enableDrag: true # allow dragging nodes in the graph +enableZoom: true # allow zooming and panning the graph +depth: -1 # how many neighbours of the current node to show (-1 is all nodes) +paths: # colour specific nodes path off of their path + - /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 actually 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). + +## Multilingual +[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 0000000..72cb466 --- /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 ` + +# 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 `/`. + +```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 +- 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). + +--- + +Now that your Quartz is live, let's figure out how to make Quartz really *yours*! + +🎨 [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 0000000..e031421 --- /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/github-actions.png b/content/notes/images/github-actions.png new file mode 100644 index 0000000..8e977cb 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 0000000..2c606f5 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 0000000..a438269 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 0000000..8dfbfdc 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 0000000..a10379e --- /dev/null +++ b/content/notes/obsidian.md @@ -0,0 +1,29 @@ +--- +title: "Obsidian Vault Integration" +tags: +- setup +--- + +## 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. + +1. Under Options > Files and Links, set the New link format to always e Absolute Path in Vault. +2. Go to Settings > Files & Links > Turn "on" automatically update internal links. + +![Obsidian Settings](/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. + +**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 recomment `[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! diff --git a/content/notes/philosophy.md b/content/notes/philosophy.md new file mode 100644 index 0000000..bf04da3 --- /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 0000000..7f12f30 --- /dev/null +++ b/content/notes/preview changes.md @@ -0,0 +1,38 @@ +--- +title: "Preview Changes" +--- + +If you'd like to preview what your Quartz site looks like before deploying it to the internet, here's exactly how to do that! + +Note that both of these steps need to be completed. + +## 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. + +```shell +# Install and link `hugo-obsidian` locally +$ go install github.com/jackyzha0/hugo-obsidian@latest + +# Navigate to your local Quartz folder +$ cd + +# Scrape all links in your Quartz folder and generate info for Quartz +$ hugo-obsidian -input=content -output=assets/indices -index -root=. +``` + +If you are running into an error saying that `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. + +Afterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated! + +## 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, + +``` +# Navigate to your local Quartz folder +$ cd + +# Start local server +$ hugo server + +# View your site in a browser at http://localhost:1313/ +``` diff --git a/content/notes/setup.md b/content/notes/setup.md new file mode 100644 index 0000000..495a43b --- /dev/null +++ b/content/notes/setup.md @@ -0,0 +1,58 @@ +--- +title: "Setup" +tags: +- setup +--- + +## 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. 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). + +### 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 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. + +✏️ [Editing Notes in Quartz](notes/editing.md) + +Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md). + +## Updating +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 the update +make update-force +``` + +Or, manually checkout the changes yourself. + +> ⚠️ **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/notes/showcase.md b/content/notes/showcase.md new file mode 100644 index 0000000..5c16a0d --- /dev/null +++ b/content/notes/showcase.md @@ -0,0 +1,17 @@ +--- +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://garden.jzhao.xyz/) +- [AWAGMI Intern Notes](https://notes.awagmi.xyz/) +- [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/) +- [Brandon Boswell's Garden](https://brandonkboswell.com) +- [Siyang's Courtyard](https://siyangsun.github.io/courtyard/) + +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 0000000..66eb879 --- /dev/null +++ b/content/notes/troubleshooting.md @@ -0,0 +1,81 @@ +--- +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 +export GOPATH=/Users/$USER/go +export PATH=$GOPATH/bin:$PATH + +# In your current terminal, to reload the session +source ~/.bash_profile +``` + +### 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 Google Analytics? +You can edit it in `config.toml` and either use a V3 (UA-) or V4 (G-) tag. + +### 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) \ No newline at end of file diff --git a/content/private/private-note.md b/content/private/private-note.md new file mode 100644 index 0000000..6930c10 --- /dev/null +++ b/content/private/private-note.md @@ -0,0 +1,5 @@ +--- +title: "Private Stuff" +--- + +This page doesn't get published! \ No newline at end of file diff --git a/content/templates/post.md b/content/templates/post.md new file mode 100644 index 0000000..c2a9b33 --- /dev/null +++ b/content/templates/post.md @@ -0,0 +1,3 @@ +--- +title: "{{title}}" +--- diff --git a/data/config.yaml b/data/config.yaml new file mode 100644 index 0000000..e33c329 --- /dev/null +++ b/data/config.yaml @@ -0,0 +1,15 @@ +name: Jacky Zhao +enableToc: true +openToc: false +enableLinkPreview: true +enableLatex: true +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. +page_title: + "πŸͺ΄ Quartz 3.2" +links: + - link_name: Twitter + link: https://twitter.com/_jzhao + - link_name: Github + link: https://github.com/jackyzha0 diff --git a/data/graphConfig.yaml b/data/graphConfig.yaml new file mode 100644 index 0000000..3f8d3fb --- /dev/null +++ b/data/graphConfig.yaml @@ -0,0 +1,6 @@ +enableLegend: false +enableDrag: true +enableZoom: true +depth: -1 # set to -1 to show full graph +paths: + - /moc: "#4388cc" \ No newline at end of file diff --git a/layouts/404.html b/layouts/404.html new file mode 100644 index 0000000..4248395 --- /dev/null +++ b/layouts/404.html @@ -0,0 +1,16 @@ + + +{{ partial "head.html" . }} + + +
+ {{partial "darkmode.html" .}} +
+

404.

+

Hey! You look a little lost. This page doesn't exist (or may be private).

+ ↳ Let's get you home. +
+
+ + + diff --git a/layouts/_default/_markup/render-image.html b/layouts/_default/_markup/render-image.html new file mode 100644 index 0000000..ff4e8b3 --- /dev/null +++ b/layouts/_default/_markup/render-image.html @@ -0,0 +1,8 @@ +{{$src := .Destination | safeURL }} +{{$external := strings.HasPrefix $src "http" }} +{{- if $external -}} +{{ .Text }} +{{- else -}} +{{$fixedUrl := (cond (hasPrefix $src "/") $src (print "/" $src)) | urlize}} +{{ .Text }} +{{- end -}} diff --git a/layouts/_default/_markup/render-link.html b/layouts/_default/_markup/render-link.html new file mode 100644 index 0000000..cdacfc1 --- /dev/null +++ b/layouts/_default/_markup/render-link.html @@ -0,0 +1,16 @@ +{{$trimmed := strings.TrimSuffix ".md" (.Destination | safeURL)}} +{{$dashedurl := replace $trimmed "%20" "-" }} +{{$external := strings.HasPrefix $dashedurl "http" }} +{{- if $external -}} +{{ .Text | safeHTML }} +{{- else -}} +{{$spacedurl := replace $trimmed "%20" " " }} +{{$fixedUrl := (cond (hasPrefix $spacedurl "/") $spacedurl (print "/" $spacedurl)) | urlize}} +{{$nonexistent := eq (.Page.GetPage $spacedurl).RelPermalink ""}} +{{$rooted := default $spacedurl (strings.TrimRight "/" (.Page.GetPage $spacedurl).RelPermalink) }} +{{- .Text | safeHTML -}} + +{{- end -}} diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html new file mode 100644 index 0000000..ccb3b93 --- /dev/null +++ b/layouts/_default/baseof.html @@ -0,0 +1,10 @@ + + +{{ block "head" . }} +{{ end }} + + +{{ block "main" . }} +{{ end }} + + \ No newline at end of file diff --git a/layouts/_default/section.html b/layouts/_default/section.html new file mode 100644 index 0000000..1a4aae0 --- /dev/null +++ b/layouts/_default/section.html @@ -0,0 +1,25 @@ + + +{{ partial "head.html" . }} + + +{{partial "search.html" .}} +
+ +
+

{{ .Site.Data.config.page_title }}

+ Search IconIcon to open search +
+ {{partial "darkmode.html" .}} +
+
+

All {{.Title}}

+ {{partial "page-list.html" .Paginator.Pages.ByLastmod.Reverse }} + {{ template "_internal/pagination.html" .}} +
+ {{partial "contact.html" .}} +
+{{partial "popover.html" .}} + + + diff --git a/layouts/_default/single.html b/layouts/_default/single.html new file mode 100644 index 0000000..88a859c --- /dev/null +++ b/layouts/_default/single.html @@ -0,0 +1,33 @@ + + +{{ partial "head.html" . }} + + +{{partial "search.html" .}} +
+ +
+

{{ .Site.Data.config.page_title }}

+ Search IconIcon to open search +
+ {{partial "darkmode.html" .}} +
+
+ {{if .Title}}

{{ .Title }}

{{end}} +

+ Last updated {{if ne .Date .Lastmod}}{{ .Lastmod.Format "January 2, 2006" }}{{else}}Unknown{{end}} +

+ + {{partial "toc.html" .}} + {{partial "textprocessing.html" . }} +
+ {{partial "footer.html" .}} + {{partial "popover.html" .}} +
+ + + diff --git a/layouts/_default/taxonomy.html b/layouts/_default/taxonomy.html new file mode 100644 index 0000000..b7a45b1 --- /dev/null +++ b/layouts/_default/taxonomy.html @@ -0,0 +1,34 @@ + + +{{ partial "head.html" . }} + + +{{partial "search.html" .}} +
+ +
+

{{ .Site.Data.config.page_title }}

+ Search IconIcon to open search +
+ {{partial "darkmode.html" .}} +
+
+

All {{.Title}}

+
+ {{ range .Site.Taxonomies.tags.ByCount }} +
+

{{ .Page.Title }}

+

{{ .Count }} notes with this tag {{if gt .Count 2}}(showing first 2 results){{end}}

+
+ {{ with ($.Site.GetPage (printf "/tags/%s" .Page.Title)) }} + {{partial "page-list.html" (first 2 .Pages.ByLastmod.Reverse)}} + {{ end }} + {{ end }} +
+
+ {{partial "contact.html" .}} +
+{{partial "popover.html" .}} + + + diff --git a/layouts/_default/term.html b/layouts/_default/term.html new file mode 100644 index 0000000..16ea85c --- /dev/null +++ b/layouts/_default/term.html @@ -0,0 +1,25 @@ + + +{{ partial "head.html" . }} + + +{{partial "search.html" .}} +
+ +
+

{{ .Site.Data.config.page_title }}

+ Search IconIcon to open search +
+ {{partial "darkmode.html" .}} +
+
+

Tag: {{.Title | humanize}}

+ {{partial "page-list.html" .Paginator.Pages}} + {{ template "_internal/pagination.html" . }} +
+ {{partial "contact.html" .}} +
+{{partial "popover.html" .}} + + + diff --git a/layouts/index.html b/layouts/index.html new file mode 100644 index 0000000..ee33d7c --- /dev/null +++ b/layouts/index.html @@ -0,0 +1,24 @@ + + +{{ partial "head.html" . }} + + +{{partial "search.html" .}} +
+ +
+

{{if .Title}}{{ .Title }}{{else}}Untitled{{end}}

+ Search IconIcon to open search +
+ {{partial "darkmode.html" .}} +
+
+ {{partial "toc.html" .}} + {{partial "textprocessing.html" . }} +
+ {{partial "footer.html" .}} + {{partial "popover.html" .}} +
+ + + diff --git a/layouts/partials/backlinks.html b/layouts/partials/backlinks.html new file mode 100644 index 0000000..425ec67 --- /dev/null +++ b/layouts/partials/backlinks.html @@ -0,0 +1,24 @@ +

Backlinks

+
    + {{$url := urls.Parse .Site.BaseURL }} + {{$host := strings.TrimRight "/" $url.Path }} + {{$curPage := strings.TrimPrefix $host (strings.TrimRight "/" .Page.RelPermalink)}} + {{$linkIndex := getJSON "/assets/indices/linkIndex.json"}} + {{$inbound := index $linkIndex.index.backlinks $curPage}} + {{$contentTable := getJSON "/assets/indices/contentIndex.json"}} + {{if $inbound}} + {{$cleanedInbound := apply (apply $inbound "index" "." "source") "replace" "." " " "-"}} + {{- range $cleanedInbound | uniq -}} + {{$l := printf "%s%s" $host .}} + {{with (index $contentTable .)}} +
  • + {{index (index . "title")}} +
    • + {{end}} + {{- end -}} + {{else}} +
  • + No backlinks found +
    • + {{end}} +
diff --git a/layouts/partials/contact.html b/layouts/partials/contact.html new file mode 100644 index 0000000..7fb991e --- /dev/null +++ b/layouts/partials/contact.html @@ -0,0 +1,14 @@ + +
+
+

Made by {{ $.Site.Data.config.name }} using Quartz, Β© {{ dateFormat "2006" now }}

+
    + {{ if not .IsHome }} +
  • Home
    • + {{end}} + {{- range $.Site.Data.config.links -}} +
  • {{.link_name}}
    • + {{- end -}} +
+
+
diff --git a/layouts/partials/darkmode.html b/layouts/partials/darkmode.html new file mode 100644 index 0000000..d7540c2 --- /dev/null +++ b/layouts/partials/darkmode.html @@ -0,0 +1,15 @@ +
+ + + +
\ No newline at end of file diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html new file mode 100644 index 0000000..6d4ef17 --- /dev/null +++ b/layouts/partials/footer.html @@ -0,0 +1,11 @@ +
+
+
+ {{partial "backlinks.html" .}} +
+
+ {{partial "graph.html" .}} +
+
+ +{{partial "contact.html" .}} \ No newline at end of file diff --git a/layouts/partials/graph.html b/layouts/partials/graph.html new file mode 100644 index 0000000..ca37968 --- /dev/null +++ b/layouts/partials/graph.html @@ -0,0 +1,25 @@ + +

Interactive Graph

+
+ +{{ $js := resources.Get "js/graph.js" | resources.Fingerprint "md5" }} + + diff --git a/layouts/partials/head.html b/layouts/partials/head.html new file mode 100644 index 0000000..195cade --- /dev/null +++ b/layouts/partials/head.html @@ -0,0 +1,46 @@ + + + + + {{ if .Title }}{{ .Title }}{{ else }}{{ $.Site.Data.config.page_title }}{{ end }} + + + + + + {{$sass := resources.Match "styles/[!_]*.scss" }} + {{$css := slice }} + {{range $sass}} + {{$scss := . | resources.ToCSS (dict "outputStyle" "compressed") }} + {{$css = $css | append $scss}} + {{end}} + {{$finalCss := $css | resources.Concat "styles.css" | resources.Fingerprint "md5" | resources.Minify }} + + + {{ $darkMode := resources.Get "js/darkmode.js" | resources.Fingerprint "md5" | resources.Minify }} + + {{partial "katex.html" .}} + + + {{$linkIndex := resources.Get "indices/linkIndex.json" | resources.Fingerprint "md5" | resources.Minify | }} + {{$contentIndex := resources.Get "indices/contentIndex.json" | resources.Fingerprint "md5" | resources.Minify }} + + +{{ template "_internal/google_analytics.html" . }} diff --git a/layouts/partials/katex.html b/layouts/partials/katex.html new file mode 100644 index 0000000..e11c4f1 --- /dev/null +++ b/layouts/partials/katex.html @@ -0,0 +1,16 @@ +{{if $.Site.Data.config.enableLatex}} + + + + +{{end}} diff --git a/layouts/partials/page-list.html b/layouts/partials/page-list.html new file mode 100644 index 0000000..bdfcd59 --- /dev/null +++ b/layouts/partials/page-list.html @@ -0,0 +1,15 @@ +
    + {{- range . -}} +
  • +
    +
    +

    {{- .Title -}}

    +

    {{- .Summary -}}{{if .Truncated}}...{{end}}

    +
    +

    + {{ .ReadingTime }} minute read. Last updated {{if ne .Date .Lastmod}}{{ .Lastmod.Format "January 2, 2006" }}{{else}}Unknown{{end}} +

    +
    +
    • + {{- end -}} +
\ No newline at end of file diff --git a/layouts/partials/popover.html b/layouts/partials/popover.html new file mode 100644 index 0000000..1d16622 --- /dev/null +++ b/layouts/partials/popover.html @@ -0,0 +1,7 @@ +{{if $.Site.Data.config.enableLinkPreview}} +{{ $js := resources.Get "js/popover.js" | resources.Fingerprint "md5" | resources.Minify }} + + +{{end}} \ No newline at end of file diff --git a/layouts/partials/search.html b/layouts/partials/search.html new file mode 100644 index 0000000..f727184 --- /dev/null +++ b/layouts/partials/search.html @@ -0,0 +1,10 @@ +
+
+ +
+
+
+
+ +{{ $js := resources.Get "js/search.js" | resources.Fingerprint "md5" | resources.Minify }} + diff --git a/layouts/partials/textprocessing.html b/layouts/partials/textprocessing.html new file mode 100644 index 0000000..2312aa4 --- /dev/null +++ b/layouts/partials/textprocessing.html @@ -0,0 +1,56 @@ +{{ $content := .Content }} +{{ $raw := .RawContent }} +{{ $page := .Page }} + +{{/* Escape slashes for Latex to fix line breaks */}} +{{$latex := findRE "\\$\\$([^\\$]+)\\$\\$" $content}} +{{range $latex}} + {{$fixed := replaceRE "\\\\(?: +|\\n)" "\\\\" .}} + {{$content = replace $content . $fixed}} +{{end}} + +{{/* Wikilinks */}} +{{$wikilinks := $content | findRE "!?\\[\\[\\S[^\\[\\]\\|]*(?:\\|[^\\[\\]]*)?\\S\\]\\]" }} +{{$codefences := $raw | findRE "\\x60[^\\x60\\n]+\\x60"}} +{{$codeblocks := $raw | findRE "\\x60{3}[^\\x60]+\\x60{3}"}} +{{$code := union $codefences $codeblocks}} +{{range $wikilinks}} + {{$cur := .}} + {{$incode := false}} + {{range $code}} + {{if (in . $cur)}} + {{$incode = true}} + {{end}} + {{end}} + {{if not $incode}} + {{if (hasPrefix . "!")}} + {{$inner := . | strings.TrimPrefix "![[" | strings.TrimSuffix "]]" }} + {{$split := split $inner "|"}} + {{$path := index $split 0 | relURL}} + {{$reference := split $path "#"}} + {{$title := index $reference 0}} + {{$display := default $title (index $split 1)}} + {{$img := printf "" $path $display}} + {{$content = replace $content . $img}} + {{else}} + {{$inner := . | strings.TrimPrefix "[[" | strings.TrimSuffix "]]" }} + {{$split := split $inner "|"}} + {{$path := index $split 0}} + {{$reference := split $path "#"}} + {{$title := index $reference 0}} + {{$block := default "" (index $reference 1)}} + {{$block = strings.TrimRight "/" (cond (eq $block "") $block (printf "#%s" $block))}} + {{$href := strings.TrimRight "/" ($page.GetPage $title).RelPermalink}} + {{$display := default $title (index $split 1)}} + {{if not $href}} + {{$link := printf "%s" $display}} + {{$content = replace $content . $link}} + {{else}} + {{$fullhref := printf "%s%s" $href $block }} + {{$link := printf "%s" $fullhref $href $display}} + {{$content = replace $content . $link}} + {{end}} + {{end}} + {{end}} +{{end}} +{{ $content | safeHTML }} diff --git a/layouts/partials/toc.html b/layouts/partials/toc.html new file mode 100644 index 0000000..acda23d --- /dev/null +++ b/layouts/partials/toc.html @@ -0,0 +1,8 @@ +{{ if (and $.Site.Data.config.enableToc (ne .Params.enableToc false) (gt .WordCount 250)) }} + +{{end}} diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..6f089e8 Binary files /dev/null and b/screenshot.png differ diff --git a/static/icon.png b/static/icon.png new file mode 100644 index 0000000..b6656a7 Binary files /dev/null and b/static/icon.png differ