mirror of
https://github.com/jackyzha0/quartz.git
synced 2025-12-23 21:04:07 -06:00
223 lines
16 KiB
HTML
223 lines
16 KiB
HTML
<!doctype html><html lang=en>
|
|
<head>
|
|
<meta charset=utf-8>
|
|
<meta name=description content="Still having trouble? Here are a list of common questions and problems people encounter when installing Quartz.
|
|
While you’re here, join our Discord :)">
|
|
<title>Troubleshooting and FAQ</title>
|
|
<meta name=viewport content="width=device-width,initial-scale=1">
|
|
<link rel="shortcut icon" type=image/png href=https://quartz.jzhao.xyz//icon.png>
|
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;600;700&family=Source+Sans+Pro:wght@400;600;700&family=Fira+Code:wght@400;700&display=swap" rel=stylesheet>
|
|
<link href=https://quartz.jzhao.xyz/styles.28256d07750dd0ab499239db662317e8.min.css rel=stylesheet>
|
|
<script src=https://quartz.jzhao.xyz/js/darkmode.46b07878b7f5d9e26ad7a3c40f8a0605.min.js></script>
|
|
<link rel=stylesheet href=https://cdn.jsdelivr.net/npm/katex@0.15.1/dist/katex.min.css integrity=sha384-R4558gYOUz8mP9YWpZJjofhk+zx0AS11p36HnD2ZKj/6JR5z27gSSULCNHIRReVs crossorigin=anonymous>
|
|
<script defer src=https://cdn.jsdelivr.net/npm/katex@0.15.1/dist/katex.min.js integrity=sha384-z1fJDqw8ZApjGO3/unPWUPsIymfsJmyrDVWC8Tv/a1HeOtGmkwNd/7xUS0Xcnvsx crossorigin=anonymous></script>
|
|
<script defer src=https://cdn.jsdelivr.net/npm/katex@0.15.1/dist/contrib/auto-render.min.js integrity=sha384-+XBljXPPiv+OzfbB3cVmLHf4hdUFHlWNZN5spNQ7rmHTXpd7WvJum6fIACpNNfIR crossorigin=anonymous></script>
|
|
<script>document.addEventListener("DOMContentLoaded",function(){renderMathInElement(document.body,{delimiters:[{left:'$$',right:'$$',display:!0},{left:'$',right:'$',display:!1}],throwOnError:!1})})</script>
|
|
<script>const BASE_URL="https://quartz.jzhao.xyz/",fetchData=Promise.all([fetch("https://quartz.jzhao.xyz/indices/linkIndex.03d0265dd1ca84fe383a8ad442b7c660.min.json").then(a=>a.json()).then(a=>({index:a.index,links:a.links})),fetch("https://quartz.jzhao.xyz/indices/contentIndex.debe2e31b5706c32312980bc17afe36c.min.json").then(a=>a.json())]).then(([{index:a,links:b},c])=>({index:a,links:b,content:c}))</script>
|
|
</head>
|
|
<script async src="https://www.googletagmanager.com/gtag/js?id=G-XYFD95KB4J"></script>
|
|
<script>var doNotTrack=!1;if(!doNotTrack){window.dataLayer=window.dataLayer||[];function gtag(){dataLayer.push(arguments)}gtag('js',new Date),gtag('config','G-XYFD95KB4J',{anonymize_ip:!1})}</script>
|
|
<body>
|
|
<div id=search-container>
|
|
<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>
|
|
</div>
|
|
</div>
|
|
<script src=https://cdn.jsdelivr.net/npm/flexsearch@0.7.21/dist/flexsearch.bundle.js integrity="sha256-i3A0NZGkhsKjVMzFxv3ksk0DZh3aXqu0l49Bbh0MdjE=" crossorigin=anonymous defer></script>
|
|
<script defer src=https://quartz.jzhao.xyz/js/search.bc849b857f2c1b822264d40635bb67b6.min.js></script>
|
|
<div class=singlePage>
|
|
<header>
|
|
<h1 id=page-title><a href=https://quartz.jzhao.xyz/>🪴 Quartz 3.2</a></h1><svg tabindex="0" id="search-icon" aria-labelledby="title desc" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 19.9 19.7"><title id="title">Search Icon</title><desc id="desc">Icon to open search</desc><g class="search-path" fill="none"><path stroke-linecap="square" d="M18.5 18.3l-5.4-5.4"/><circle cx="8" cy="8" r="7"/></g></svg>
|
|
<div class=spacer></div>
|
|
<div class=darkmode>
|
|
<input class=toggle id=darkmode-toggle type=checkbox tabindex=-1>
|
|
<label id=toggle-label-light for=darkmode-toggle tabindex=-1><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" id="dayIcon" viewBox="0 0 35 35" style="enable-background:new 0 0 35 35"><title>Light Mode</title><path d="M6 17.5C6 16.672 5.328 16 4.5 16h-3C.672 16 0 16.672.0 17.5S.672 19 1.5 19h3C5.328 19 6 18.328 6 17.5zM7.5 26c-.414.0-.789.168-1.061.439l-2 2C4.168 28.711 4 29.086 4 29.5 4 30.328 4.671 31 5.5 31c.414.0.789-.168 1.06-.44l2-2C8.832 28.289 9 27.914 9 27.5 9 26.672 8.329 26 7.5 26zm10-20C18.329 6 19 5.328 19 4.5v-3C19 .672 18.329.0 17.5.0S16 .672 16 1.5v3C16 5.328 16.671 6 17.5 6zm10 3c.414.0.789-.168 1.06-.439l2-2C30.832 6.289 31 5.914 31 5.5 31 4.672 30.329 4 29.5 4c-.414.0-.789.168-1.061.44l-2 2C26.168 6.711 26 7.086 26 7.5 26 8.328 26.671 9 27.5 9zM6.439 8.561C6.711 8.832 7.086 9 7.5 9 8.328 9 9 8.328 9 7.5c0-.414-.168-.789-.439-1.061l-2-2C6.289 4.168 5.914 4 5.5 4 4.672 4 4 4.672 4 5.5c0 .414.168.789.439 1.06l2 2.001zM33.5 16h-3c-.828.0-1.5.672-1.5 1.5s.672 1.5 1.5 1.5h3c.828.0 1.5-.672 1.5-1.5S34.328 16 33.5 16zM28.561 26.439C28.289 26.168 27.914 26 27.5 26c-.828.0-1.5.672-1.5 1.5.0.414.168.789.439 1.06l2 2C28.711 30.832 29.086 31 29.5 31c.828.0 1.5-.672 1.5-1.5.0-.414-.168-.789-.439-1.061l-2-2zM17.5 29c-.829.0-1.5.672-1.5 1.5v3c0 .828.671 1.5 1.5 1.5s1.5-.672 1.5-1.5v-3C19 29.672 18.329 29 17.5 29zm0-22C11.71 7 7 11.71 7 17.5S11.71 28 17.5 28 28 23.29 28 17.5 23.29 7 17.5 7zm0 18c-4.136.0-7.5-3.364-7.5-7.5s3.364-7.5 7.5-7.5 7.5 3.364 7.5 7.5S21.636 25 17.5 25z"/></svg>
|
|
</label>
|
|
<label id=toggle-label-dark for=darkmode-toggle tabindex=-1><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" id="nightIcon" viewBox="0 0 100 100" style="enable-background='new 0 0 100 100'"><title>Dark Mode</title><path d="M96.76 66.458c-.853-.852-2.15-1.064-3.23-.534-6.063 2.991-12.858 4.571-19.655 4.571C62.022 70.495 50.88 65.88 42.5 57.5 29.043 44.043 25.658 23.536 34.076 6.47c.532-1.08.318-2.379-.534-3.23-.851-.852-2.15-1.064-3.23-.534-4.918 2.427-9.375 5.619-13.246 9.491-9.447 9.447-14.65 22.008-14.65 35.369.0 13.36 5.203 25.921 14.65 35.368s22.008 14.65 35.368 14.65c13.361.0 25.921-5.203 35.369-14.65 3.872-3.871 7.064-8.328 9.491-13.246C97.826 68.608 97.611 67.309 96.76 66.458z"/></svg>
|
|
</label>
|
|
</div>
|
|
</header>
|
|
<article>
|
|
<h1>Troubleshooting and FAQ</h1>
|
|
<p class=meta>
|
|
Last updated April 5, 2022
|
|
</p>
|
|
<ul class=tags>
|
|
</ul>
|
|
<aside class=mainTOC>
|
|
<details>
|
|
<summary>Table of Contents</summary>
|
|
<nav id=TableOfContents>
|
|
<ol>
|
|
<li>
|
|
<ol>
|
|
<li><a href=#does-quartz-have-latex-support>Does Quartz have Latex support?</a></li>
|
|
<li><a href=#can-i-use-obsidian-plugin-in-quartz>Can I use <Obsidian Plugin> in Quartz?</a></li>
|
|
<li><a href=#my-github-pages-is-just-showing-the-readme-and-not-quartz>My GitHub pages is just showing the README and not Quartz</a></li>
|
|
<li><a href=#some-of-my-pages-have-january-1-0001-as-the-last-modified-date>Some of my pages have ‘January 1, 0001’ as the last modified date</a></li>
|
|
<li><a href=#can-i-publish-only-a-subset-of-my-pages>Can I publish only a subset of my pages?</a></li>
|
|
<li><a href=#can-i-host-this-myself-and-not-on-github-pages>Can I host this myself and not on GitHub Pages?</a></li>
|
|
<li><a href=#command-not-found-hugo-obsidian><code>command not found: hugo-obsidian</code></a></li>
|
|
<li><a href=#how-come-my-notes-arent-being-rendered>How come my notes aren’t being rendered?</a></li>
|
|
<li><a href=#my-custom-domain-isnt-working>My custom domain isn’t working!</a></li>
|
|
<li><a href=#how-do-i-setup-google-analytics>How do I setup Google Analytics?</a></li>
|
|
<li><a href=#how-do-i-change-the-content-on-the-home-page>How do I change the content on the home page?</a></li>
|
|
<li><a href=#how-do-i-change-the-colours>How do I change the colours?</a></li>
|
|
<li><a href=#how-do-i-add-images>How do I add images?</a></li>
|
|
<li><a href=#my-interactive-graph-and-backlinks-arent-up-to-date>My Interactive Graph and Backlinks aren’t up to date</a></li>
|
|
<li><a href=#can-i-use-reactvuesome-other-framework>Can I use React/Vue/some other framework?</a></li>
|
|
</ol>
|
|
</li>
|
|
<li><a href=#still-stuck>Still Stuck?</a></li>
|
|
</ol>
|
|
</nav>
|
|
</details>
|
|
</aside>
|
|
<p>Still having trouble? Here are a list of common questions and problems people encounter when installing Quartz.</p>
|
|
<p>While you’re here, join our
|
|
<a href=https://discord.gg/cRFFHYye7t rel=noopener>Discord</a> :)</p>
|
|
<h3 id=does-quartz-have-latex-support>Does Quartz have Latex support?</h3>
|
|
<p>Yes! See
|
|
<a href=/notes/CJK-+-Latex-Support-%E6%B5%8B%E8%AF%95 rel=noopener class=internal-link data-src=/notes/CJK-+-Latex-Support-%E6%B5%8B%E8%AF%95>CJK + Latex Support (测试)
|
|
</a> for a brief demo.</p>
|
|
<h3 id=can-i-use-obsidian-plugin-in-quartz>Can I use <Obsidian Plugin> in Quartz?</h3>
|
|
<p>Unless it produces direct Markdown output in the file, no. There currently is no way to bundle plugin code with Quartz.</p>
|
|
<p>The easiest way would be to add your own HTML partial that supports the functionality you are looking for.</p>
|
|
<h3 id=my-github-pages-is-just-showing-the-readme-and-not-quartz>My GitHub pages is just showing the README and not Quartz</h3>
|
|
<p>Make sure you set the source to deploy from <code>master</code> (and not <code>hugo</code>) using <code>/ (root)</code>! See more in the
|
|
<a href=/notes/hosting rel=noopener class=internal-link data-src=/notes/hosting>hosting
|
|
</a> guide</p>
|
|
<h3 id=some-of-my-pages-have-january-1-0001-as-the-last-modified-date>Some of my pages have ‘January 1, 0001’ as the last modified date</h3>
|
|
<p>This is a problem caused by <code>git</code> 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.</p>
|
|
<div class=highlight><div class=chroma>
|
|
<table class=lntable><tr><td class=lntd>
|
|
<pre tabindex=0 class=chroma><code><span class=lnt>1
|
|
</span><span class=lnt>2
|
|
</span><span class=lnt>3
|
|
</span><span class=lnt>4
|
|
</span><span class=lnt>5
|
|
</span></code></pre></td>
|
|
<td class=lntd>
|
|
<pre tabindex=0 class=chroma><code class=language-shell data-lang=shell><span class=c1># in the root of your Quartz (same folder as config.toml)</span>
|
|
git config core.ignorecase <span class=nb>true</span>
|
|
|
|
<span class=c1># or globally (not recommended)</span>
|
|
git config --global core.ignorecase <span class=nb>true</span>
|
|
</code></pre></td></tr></table>
|
|
</div>
|
|
</div><h3 id=can-i-publish-only-a-subset-of-my-pages>Can I publish only a subset of my pages?</h3>
|
|
<p>Yes! Quartz makes selective publishing really easy. Heres a guide on
|
|
<a href=/notes/ignore-notes rel=noopener class=internal-link data-src=/notes/ignore-notes>excluding pages from being published
|
|
</a>.</p>
|
|
<h3 id=can-i-host-this-myself-and-not-on-github-pages>Can I host this myself and not on GitHub Pages?</h3>
|
|
<p>Yes! All built files can be found under <code>/public</code> in the <code>master</code> branch. More details under
|
|
<a href=/notes/hosting rel=noopener class=internal-link data-src=/notes/hosting>hosting
|
|
</a>.</p>
|
|
<h3 id=command-not-found-hugo-obsidian><code>command not found: hugo-obsidian</code></h3>
|
|
<p>Make sure you set your <code>GOPATH</code> correctly! This will allow your terminal to correctly recognize <code>hugo-obsidian</code> as an executable.</p>
|
|
<div class=highlight><div class=chroma>
|
|
<table class=lntable><tr><td class=lntd>
|
|
<pre tabindex=0 class=chroma><code><span class=lnt>1
|
|
</span><span class=lnt>2
|
|
</span><span class=lnt>3
|
|
</span><span class=lnt>4
|
|
</span><span class=lnt>5
|
|
</span><span class=lnt>6
|
|
</span></code></pre></td>
|
|
<td class=lntd>
|
|
<pre tabindex=0 class=chroma><code class=language-shell data-lang=shell><span class=c1># Add the following 2 lines to your ~/.bash_profile</span>
|
|
<span class=nb>export</span> <span class=nv>GOPATH</span><span class=o>=</span>/Users/<span class=nv>$USER</span>/go
|
|
<span class=nb>export</span> <span class=nv>PATH</span><span class=o>=</span><span class=nv>$GOPATH</span>/bin:<span class=nv>$PATH</span>
|
|
|
|
<span class=c1># In your current terminal, to reload the session</span>
|
|
<span class=nb>source</span> ~/.bash_profile
|
|
</code></pre></td></tr></table>
|
|
</div>
|
|
</div><h3 id=how-come-my-notes-arent-being-rendered>How come my notes aren’t being rendered?</h3>
|
|
<p>You probably forgot to include front matter in your Markdown files. You can either setup
|
|
<a href=/notes/obsidian rel=noopener class=internal-link data-src=/notes/obsidian>Obsidian
|
|
</a> to do this for you or you need to manually define it. More details in
|
|
<a href=/notes/editing rel=noopener class=internal-link data-src=/notes/editing>the ‘how to edit’ guide
|
|
</a>.</p>
|
|
<h3 id=my-custom-domain-isnt-working>My custom domain isn’t working!</h3>
|
|
<p>Walk through the steps in
|
|
<a href=/notes/hosting rel=noopener class=internal-link data-src=/notes/hosting>the hosting guide
|
|
</a> again. Make sure you wait 30 min to 1 hour for changes to take effect.</p>
|
|
<h3 id=how-do-i-setup-google-analytics>How do I setup Google Analytics?</h3>
|
|
<p>You can edit it in <code>config.toml</code> and either use a V3 (UA-) or V4 (G-) tag.</p>
|
|
<h3 id=how-do-i-change-the-content-on-the-home-page>How do I change the content on the home page?</h3>
|
|
<p>To edit the main home page, open <code>/content/_index.md</code>.</p>
|
|
<h3 id=how-do-i-change-the-colours>How do I change the colours?</h3>
|
|
<p>You can change the theme by editing <code>assets/custom.scss</code>. More details on customization and themeing can be found in the
|
|
<a href=/notes/config rel=noopener class=internal-link data-src=/notes/config>customization guide
|
|
</a>.</p>
|
|
<h3 id=how-do-i-add-images>How do I add images?</h3>
|
|
<p>You can put images anywhere in the <code>/content</code> folder.</p>
|
|
<div class=highlight><div class=chroma>
|
|
<table class=lntable><tr><td class=lntd>
|
|
<pre tabindex=0 class=chroma><code><span class=lnt>1
|
|
</span><span class=lnt>2
|
|
</span></code></pre></td>
|
|
<td class=lntd>
|
|
<pre tabindex=0 class=chroma><code class=language-markdown data-lang=markdown>Example image (source is in content/notes/images/example.png)
|
|
|
|
</code></pre></td></tr></table>
|
|
</div>
|
|
</div><h3 id=my-interactive-graph-and-backlinks-arent-up-to-date>My Interactive Graph and Backlinks aren’t up to date</h3>
|
|
<p>By default, the <code>linkIndex.json</code> (which Quartz needs to generate the Interactive Graph and Backlinks) are not regenerated locally. To set that up, see the guide on
|
|
<a href=/notes/editing rel=noopener class=internal-link data-src=/notes/editing>local editing
|
|
</a></p>
|
|
<h3 id=can-i-use-reactvuesome-other-framework>Can I use React/Vue/some other framework?</h3>
|
|
<p>Not out of the box. You could probably make it work by editing <code>/layouts/_default/single.html</code> 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.</p>
|
|
<h2 id=still-stuck>Still Stuck?</h2>
|
|
<p>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
|
|
<a href=https://twitter.com/_jzhao rel=noopener>Twitter</a> and I’ll try to get back to you as soon as I can.</p>
|
|
<p>🐛
|
|
<a href=https://github.com/jackyzha0/quartz/issues rel=noopener>Submit an Issue</a></p>
|
|
</article>
|
|
<hr>
|
|
<div class=page-end>
|
|
<div class=backlinks-container>
|
|
<h3>Backlinks</h3>
|
|
<ul class=backlinks>
|
|
<li>
|
|
<a href=/>🪴 Quartz 3.2</a>
|
|
</li>
|
|
<li>
|
|
<a href=/notes/config>Configuration</a>
|
|
</li>
|
|
<li>
|
|
<a href=/notes/editing>Editing Content in Quartz</a>
|
|
</li>
|
|
<li>
|
|
<a href=/notes/hosting>Deploying Quartz to the Web</a>
|
|
</li>
|
|
<li>
|
|
<a href=/notes/setup>Setup</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div>
|
|
<script src=https://cdn.jsdelivr.net/npm/d3@6.7.0/dist/d3.min.js integrity="sha256-+7jaYCp29O1JusNWHaYtgUn6EhuP0VaFuswhNV06MyI=" crossorigin=anonymous></script>
|
|
<h3>Interactive Graph</h3>
|
|
<div id=graph-container></div>
|
|
<style>:root{--g-node:var(--secondary);--g-node-active:var(--primary);--g-node-inactive:var(--visited);--g-link:var(--outlinegray);--g-link-active:#5a7282}</style>
|
|
<script src=https://quartz.jzhao.xyz/js/graph.27e8521c25c27c79dea35f434c486167.js></script>
|
|
<script>drawGraph("https://quartz.jzhao.xyz/notes/troubleshooting","https://quartz.jzhao.xyz",[{"/moc":"#4388cc"}],-1,!0,!1,!0)</script>
|
|
</div>
|
|
</div>
|
|
<div id=contact_buttons>
|
|
<footer>
|
|
<p>Made by Jacky Zhao using <a href=https://github.com/jackyzha0/quartz>Quartz</a>, © 2022</p>
|
|
<ul>
|
|
<li><a href=/>Home</a></li>
|
|
<li><a href=https://twitter.com/_jzhao>Twitter</a></li><li><a href=https://github.com/jackyzha0>Github</a></li></ul>
|
|
</footer>
|
|
</div>
|
|
<script src=https://quartz.jzhao.xyz/js/popover.9d69dffc0f2d029ef30cf63230ccce4c.min.js></script>
|
|
<script>initPopover("https://quartz.jzhao.xyz")</script>
|
|
</div>
|
|
</body>
|
|
</html> |