diff --git a/content/_index.md b/content/_index.md index f8bfcf39b..96afd83e1 100644 --- a/content/_index.md +++ b/content/_index.md @@ -7,14 +7,14 @@ enableToc: false - And this is a collection of my notes, resources and just about everything I do everyday. #### My Content - * Today I Learned Notes - * Resource Repositories - * logs -- comming soon +- Today I Learned Notes[Notes](editing.md) +- Resource Repositories +- logs -- comming soon #### Skills I have in my Portfolio currently -* Python Programming +- Python Programming #### Connect with me -* Twitter - https://twitter.com/Vedantpr0 -* LinkedIn - https://www.linkedin.com/in/VedantAndhale -* GitHub - https://github.com/VedantAndhale \ No newline at end of file +- Twitter - https://twitter.com/Vedantpr0 +- LinkedIn - https://www.linkedin.com/in/VedantAndhale +- GitHub - https://github.com/VedantAndhale \ No newline at end of file diff --git a/content/private/search.md b/content/notes/search.md similarity index 100% rename from content/private/search.md rename to content/notes/search.md diff --git a/content/private/setup.md b/content/notes/setup.md similarity index 100% rename from content/private/setup.md rename to content/notes/setup.md diff --git a/content/private/CJK + Latex Support (测试).md b/content/private/CJK + Latex Support (测试).md deleted file mode 100644 index 0f9afc273..000000000 --- a/content/private/CJK + Latex Support (测试).md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "CJK + Latex Support (测试)" ---- - -## Chinese, Japanese, Korean Support -几乎在我们意识到之前，我们已经离开了地面。 - -우리가 그것을 알기도 전에 우리는 땅을 떠났습니다. - -私たちがそれを知るほぼ前に、私たちは地面を離れていました。 - -## Latex - -Block math works with two dollar signs `$$...$$` - -$$f(x) = \int_{-\infty}^\infty - f\hat(\xi),e^{2 \pi i \xi x} - \,d\xi$$ - -Inline math also works with single dollar signs `$...$`. For example, Euler's identity but inline: $e^{i\pi} = -1$ - -Aligned equations work quite well: - -$$ -\begin{aligned} -a &= b + c \\ &= e + f \\ -\end{aligned} -$$ - -And matrices - -$$ -\begin{bmatrix} -1 & 2 & 3 \\ -a & b & c -\end{bmatrix} -$$ - -## RTL -More information on configuring RTL languages like Arabic in the [config](notes/config.md) page. diff --git a/content/private/callouts.md b/content/private/callouts.md deleted file mode 100644 index 74b837d61..000000000 --- a/content/private/callouts.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "Callouts" ---- - -## Callout support - -Quartz supports the same Admonition-callout syntax as Obsidian. - -This includes -- 12 Distinct callout types (each with several aliases) -- Collapsable callouts - -See [documentation on supported types and syntax here](https://help.obsidian.md/How+to/Use+callouts#Types). - -## Showcase - -> [!EXAMPLE] Examples -> -> Aliases: example - -> [!note] Notes -> -> Aliases: note - -> [!abstract] Summaries -> -> Aliases: abstract, summary, tldr - -> [!info] Info -> -> Aliases: info, todo - -> [!tip] Hint -> -> Aliases: tip, hint, important - -> [!success] Success -> -> Aliases: success, check, done - -> [!question] Question -> -> Aliases: question, help, faq - -> [!warning] Warning -> -> Aliases: warning, caution, attention - -> [!failure] Failure -> -> Aliases: failure, fail, missing - -> [!danger] Error -> -> Aliases: danger, error - -> [!bug] Bug -> -> Aliases: bug - -> [!quote] Quote -> -> Aliases: quote, cite diff --git a/content/private/config.md b/content/private/config.md deleted file mode 100644 index 68c7db546..000000000 --- a/content/private/config.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -title: "Configuration" -tags: -- setup -weight: 0 ---- - -## Configuration -Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you'd like to get. - -The majority of configuration can be found under `data/config.yaml`. An annotated example configuration is shown below. - -```yaml {title="data/config.yaml"} -# The name to display in the footer -name: Vedant Andhale - -# whether to globally show the table of contents on each page -# this can be turned off on a per-page basis by adding this to the -# front-matter of that note -enableToc: true - -# whether to by-default open or close the table of contents on each page -openToc: false - -# whether to display on-hover link preview cards -enableLinkPreview: true - -# whether to render titles for code blocks -enableCodeBlockTitle: true - -# whether to render copy buttons for code blocks -enableCodeBlockCopy: true - -# whether to render callouts -enableCallouts: true - -# whether to try to process Latex -enableLatex: true - -# whether to enable single-page-app style rendering -# this prevents flashes of unstyled content and improves -# smoothness of Quartz. More info in issue #109 on GitHub -enableSPA: true - -# whether to render a footer -enableFooter: true - -# whether backlinks of pages should show the context in which -# they were mentioned -enableContextualBacklinks: true - -# whether to show a section of recent notes on the home page -enableRecentNotes: false - -# whether to display an 'edit' button next to the last edited field -# that links to github -enableGitHubEdit: true -GitHubLink: https://github.com/VedantAndhale/vedantandhale.github.io/tree/hugo/content - -# whether to render mermaid diagrams -enableMermaid: true - -# whether to use Operand to power semantic search -# IMPORTANT: replace this API key with your own if you plan on using -# Operand search! -search: - enableSemanticSearch: false - operandApiKey: "REPLACE-WITH-YOUR-OPERAND-API-KEY" - operandIndexId: "REPLACE-WITH-YOUR-OPERAND-INDEX-ID" - -# page description used for SEO -description: - Host your second brain and digital garden for free. Quartz features extremely fast full-text search, - Wikilink support, backlinks, local graph, tags, and link previews. - -# title of the home page (also for SEO) -page_title: - "Vedant Andhale" - -# links to show in the footer -links: - - link_name: Twitter - link: https://twitter.com/Vedantpr0 - - link_name: Github - link: https://github.com/VedantAndhale -``` - -### Code Block Titles -To add code block titles with Quartz: - -1. Ensure that code block titles are enabled in Quartz's configuration: - - ```yaml {title="data/config.yaml", linenos=false} - enableCodeBlockTitle: true - ``` - -2. Add the `title` attribute to the desired [code block - fence](https://gohugo.io/content-management/syntax-highlighting/#highlighting-in-code-fences): - - ```markdown {linenos=false} - ```yaml {title="data/config.yaml"} - enableCodeBlockTitle: true # example from step 1 - ``` - ``` - -**Note** that if `{title=}` is included, and code block titles are not -enabled, no errors will occur, and the title attribute will be ignored. - -### HTML Favicons -If you would like to customize the favicons of your Quartz-based website, you -can add them to the `data/config.yaml` file. The **default** without any set -`favicon` key is: - -```html {title="layouts/partials/head.html", linenostart=15} - -``` - -The default can be overridden by defining a value to the `favicon` key in your -`data/config.yaml` file. For example, here is a `List[Dictionary]` example format, which is -equivalent to the default: - -```yaml {title="data/config.yaml", linenos=false} -favicon: - - { rel: "shortcut icon", href: "icon.png", type: "image/png" } -# - { ... } # Repeat for each additional favicon you want to add -``` - -In this format, the keys are identical to their HTML representations. - -If you plan to add multiple favicons generated by a website (see list below), it -may be easier to define it as HTML. Here is an example which appends the -**Apple touch icon** to Quartz's default favicon: - -```yaml {title="data/config.yaml", linenos=false} -favicon: | - - -``` - -This second favicon will now be used as a web page icon when someone adds your -webpage to the home screen of their Apple device. If you are interested in more -information about the current and past standards of favicons, you can read -[this article](https://www.emergeinteractive.com/insights/detail/the-essentials-of-favicons/). - -**Note** that all generated favicon paths, defined by the `href` -attribute, are relative to the `static/` directory. - -### Graph View -To customize the Interactive Graph view, you can poke around `data/graphConfig.yaml`. - -```yaml {title="data/graphConfig.yaml"} -# if true, a Global Graph will be shown on home page with full width, no backlink. -# A different set of Local Graphs will be shown on sub pages. -# if false, Local Graph will be default on every page as usual -enableGlobalGraph: false - -### Local Graph ### -localGraph: - # whether automatically generate a legend - enableLegend: false - - # whether to allow dragging nodes in the graph - enableDrag: true - - # whether to allow zooming and panning the graph - enableZoom: true - - # how many neighbours of the current node to show (-1 is all nodes) - depth: 1 - - # initial zoom factor of the graph - scale: 1.2 - - # how strongly nodes should repel each other - repelForce: 2 - - # how strongly should nodes be attracted to the center of gravity - centerForce: 1 - - # what the default link length should be - linkDistance: 1 - - # how big the node labels should be - fontSize: 0.6 - - # scale at which to start fading the labes on nodes - opacityScale: 3 - -### Global Graph ### -globalGraph: - # same settings as above - -### For all graphs ### -# colour specific nodes path off of their path -paths: - - /moc: "#4388cc" -``` - - -## Styling -Want to go even more in-depth? You can add custom CSS styling and change existing colours through editing `assets/styles/custom.scss`. If you'd like to target specific parts of the site, you can add ids and classes to the HTML partials in `/layouts/partials`. - -### Partials -Partials are what dictate what gets rendered to the page. Want to change how pages are styled and structured? You can edit the appropriate layout in `/layouts`. - -For example, the structure of the home page can be edited through `/layouts/index.html`. To customize the footer, you can edit `/layouts/partials/footer.html` - -More info about partials on [Hugo's website.](https://gohugo.io/templates/partials/) - -Still having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md). - -## Language Support -[CJK + Latex Support (测试)](notes/CJK%20+%20Latex%20Support%20(测试).md) comes out of the box with Quartz. - -Want to support languages that read from right-to-left (like Arabic)? Hugo (and by proxy, Quartz) supports this natively. - -Follow the steps [Hugo provides here](https://gohugo.io/content-management/multilingual/#configure-languages) and modify your `config.toml` - -For example: - -```toml -defaultContentLanguage = 'ar' -[languages] - [languages.ar] - languagedirection = 'rtl' - title = 'مدونتي' - weight = 1 -``` diff --git a/content/private/custom Domain.md b/content/private/custom Domain.md deleted file mode 100644 index 72cb466eb..000000000 --- a/content/private/custom Domain.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: "Custom Domain" ---- - -### Registrar -This step is only applicable if you are using a **custom domain**! If you are using a `.github.io` domain, you can skip this step. - -For this last bit to take effect, you also need to create a CNAME record with the DNS provider you register your domain with (i.e. NameCheap, Google Domains). - -GitHub has some [documentation on this](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site), but the tldr; is to - -1. Go to your forked repository (`github.com//quartz`) settings page and go to the Pages tab. Under "Custom domain", type your custom domain, then click **Save**. -2. Go to your DNS Provider and create a CNAME record that points from your domain to ` 🔗 Step 3: [How to setup your Obsidian Vault to work with Quartz](notes/obsidian.md) - -## Previewing Changes -This step is purely optional and mostly for those who want to see the published version of their digital garden locally before opening it up to the internet. This is *highly recommended* but not required. - -> 👀 Step 4: [Preview Quartz Changes](notes/preview%20changes.md) - -For those who like to live life more on the edge, viewing the garden through Obsidian gets you pretty close to the real thing. - -## Publishing Changes -Now that you know the basics of managing your digital garden using Quartz, you can publish it to the internet! - -> 🌍 Step 5: [Hosting Quartz online!](notes/hosting.md) - -Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md). diff --git a/content/private/hosting.md b/content/private/hosting.md deleted file mode 100644 index 254d7af95..000000000 --- a/content/private/hosting.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -title: "Deploying Quartz to the Web" -tags: -- setup -weight: -1 -aliases: -- hosting ---- - -## Hosting on GitHub Pages -Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go! Follow the steps below. - -### Enable GitHub Actions -By default, GitHub disables workflows from running automatically on Forked Repostories. Head to the 'Actions' tab of your forked repository and Enable Workflows to setup deploying your Quartz site! - -![Enable GitHub Actions](notes/images/github-actions.png)*Enable GitHub Actions* - -### Enable GitHub Pages - -Head to the 'Settings' tab of your forked repository and go to the 'Pages' tab. - -1. (IMPORTANT) Set the source to deploy from `master` (and not `hugo`) using `/ (root)` -2. Set a custom domain here if you have one! - -![Enable GitHub Pages](/notes/images/github-pages.png)*Enable GitHub Pages* - -### Pushing Changes -To see your changes on the internet, we need to push it them to GitHub. Quartz is a `git` repository so updating it is the same workflow as you would follow as if it were just a regular software project. - -```shell -# Navigate to Quartz folder -cd - -# Commit all changes -git add . -git commit -m "message describing changes" - -# Push to GitHub to update site -git push origin hugo -``` - -Note: we specifically push to the `hugo` branch here. Our GitHub action automatically runs everytime a push to is detected to that branch and then updates the `master` branch for redeployment. - -### Setting up the Site -Now let's get this site up and running. Never hosted a site before? No problem. Have a fancy custom domain you already own or want to subdomain your Quartz? That's easy too. - -Here, we take advantage of GitHub's free page hosting to deploy our site. Change `baseURL` in `/config.toml`. - -Make sure that your `baseURL` has a trailing `/`! - -[Reference `config.toml` here](https://github.com/jackyzha0/quartz/blob/hugo/config.toml) - -```toml -baseURL = "https:///" -``` - -If you are using this under a subdomain (e.g. `.github.io/quartz`), include the trailing `/`. **You need to do this especially if you are using GitHub!** - -```toml -baseURL = "https://.github.io/quartz/" -``` - -Change `cname` in `/.github/workflows/deploy.yaml`. Again, if you don't have a custom domain to use, you can use `.github.io`. - -Please note that the `cname` field should *not* have any path `e.g. end with /quartz` or have a trailing `/`. - -[Reference `deploy.yaml` here](https://github.com/jackyzha0/quartz/blob/hugo/.github/workflows/deploy.yaml) - -```yaml {title=".github/workflows/deploy.yaml"} -- name: Deploy - uses: peaceiris/actions-gh-pages@v3 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} # this can stay as is, GitHub fills this in for us! - publish_dir: ./public - publish_branch: master - cname: -``` - -Have a custom domain? [Learn how to set it up with Quartz ](notes/custom%20Domain.md). - -### Ignoring Files -Only want to publish a subset of all of your notes? Don't worry, Quartz makes this a simple two-step process. - -❌ [Excluding pages from being published](notes/ignore%20notes.md) - -## Docker Support -If you don't want to use a hosting service, you can host using [Docker](notes/docker.md) instead! -I would *not use this method* unless you know what you are doing. - ---- - -Now that your Quartz is live, let's figure out how to make Quartz really *yours*! - -> Step 6: 🎨 [Customizing Quartz](notes/config.md) - -Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md). diff --git a/content/private/ignore notes.md b/content/private/ignore notes.md deleted file mode 100644 index e0314211d..000000000 --- a/content/private/ignore notes.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -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/private/images/github-actions.png b/content/private/images/github-actions.png deleted file mode 100644 index 8e977cb17..000000000 Binary files a/content/private/images/github-actions.png and /dev/null differ diff --git a/content/private/images/github-pages.png b/content/private/images/github-pages.png deleted file mode 100644 index 2c606f588..000000000 Binary files a/content/private/images/github-pages.png and /dev/null differ diff --git a/content/private/images/google-domains.png b/content/private/images/google-domains.png deleted file mode 100644 index a43826999..000000000 Binary files a/content/private/images/google-domains.png and /dev/null differ diff --git a/content/private/images/obsidian-settings.png b/content/private/images/obsidian-settings.png deleted file mode 100644 index 8dfbfdc34..000000000 Binary files a/content/private/images/obsidian-settings.png and /dev/null differ diff --git a/content/private/obsidian.md b/content/private/obsidian.md deleted file mode 100644 index 0667b46e8..000000000 --- a/content/private/obsidian.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "Obsidian Vault Integration" -tags: -- setup -weight: -3 ---- - -## Setup -Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have. - -### New Vault -If you don't have an existing Vault, [download Obsidian](https://obsidian.md/) and create a new Vault in the `/content` folder that you created and cloned during the [setup](notes/setup.md) step. - -### Linking an existing Vault -The easiest way to use an existing Vault is to copy all of your files (directory and hierarchies intact) into the `/content` folder. - -## Settings -Great, now that you have your Obsidian linked to your Quartz, let's fix some settings so that they play well. - -Open Settings > Files & Links and look for these two items: - -1. Set the **New link format** to **Absolute Path in vault**. -2. Turn **on** the **Automatically update internal links** setting. - -![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 recommend `[cmd]+T`). That way, when you create a new note, you can just press the hotkey for a new template and be ready to go! - -> 👀 Step 4: [Preview Quartz Changes](notes/preview%20changes.md) diff --git a/content/private/philosophy.md b/content/private/philosophy.md deleted file mode 100644 index bf04da3b1..000000000 --- a/content/private/philosophy.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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/private/preview changes.md b/content/private/preview changes.md deleted file mode 100644 index 8ea07a391..000000000 --- a/content/private/preview changes.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "Preview Changes" -tags: -- setup -weight: -2 ---- - -If you'd like to preview what your Quartz site looks like before deploying it to the internet, the following -instructions guide you through installing the proper dependencies to run it locally. - - -## Install `hugo-obsidian` -This step will generate the list of backlinks for Hugo to parse. Ensure you have [Go](https://golang.org/doc/install) (>= 1.16) installed. - -```bash -# Install and link `hugo-obsidian` locally -go install github.com/jackyzha0/hugo-obsidian@latest -``` - -If you are running into an error saying that `command not found: hugo-obsidian`, make sure you set your `GOPATH` correctly! 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, - -```bash -# Navigate to your local Quartz folder -cd - -# Start local server -make serve - -# View your site in a browser at http://localhost:1313/ -``` - -> [!INFO] Docker Support -> -> If you have Docker installed already, open your terminal, navigate to your folder with Quartz and run `make docker` - -Now that you are happy with how your Quartz instance looks, let's get it hosted! - -> 🌍 Step 5: [Hosting Quartz online!](notes/hosting.md) diff --git a/content/private/private-note.md b/content/private/private-note.md deleted file mode 100644 index 6930c102c..000000000 --- a/content/private/private-note.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Private Stuff" ---- - -This page doesn't get published! \ No newline at end of file diff --git a/content/private/showcase.md b/content/private/showcase.md deleted file mode 100644 index bc8c4d2fd..000000000 --- a/content/private/showcase.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "Showcase" ---- - -Want to see what Quartz can do? Here are some cool community gardens :) - -- [Quartz Documentation (this site!)](https://quartz.jzhao.xyz/) -- [Jacky Zhao's Garden](https://jzhao.xyz/) -- [Scaling Synthesis - A hypertext research notebook](https://scalingsynthesis.com/) -- [AWAGMI Intern Notes](https://notes.awagmi.xyz/) -- [Shihyu's PKM](https://shihyuho.github.io/pkm/) -- [SlRvb's Site](https://slrvb.github.io/Site/) -- [Course notes for Information Technology Advanced Theory](https://a2itnotes.github.io/quartz/) -- [Brandon Boswell's Garden](https://brandonkboswell.com) -- [Siyang's Courtyard](https://siyangsun.github.io/courtyard/) -- [Data Dictionary 🧠](https://glossary.airbyte.com/) -- [sspaeti.com's Second Brain](https://brain.sspaeti.com/) -- [oldwinterの数字花园](https://garden.oldwinter.top/) -- [SethMB Work](https://sethmb.xyz/) -- [Abhijeet's Math Wiki](https://abhmul.github.io/quartz/Math-Wiki/) - -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/private/troubleshooting.md b/content/private/troubleshooting.md deleted file mode 100644 index 79dec15df..000000000 --- a/content/private/troubleshooting.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -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 analytics? -Quartz by default uses [Plausible](https://plausible.io/) for analytics. - -If you would prefer to use Google Analytics, you can follow this [guide in the Hugo documentation](https://gohugo.io/templates/internal/#google-analytics). - -Alternatively, you can also import your Google Analytics data into Plausible by [following this guide](https://plausible.io/docs/google-analytics-import). - - -### How do I change the content on the home page? -To edit the main home page, open `/content/_index.md`. - -### How do I change the colours? -You can change the theme by editing `assets/custom.scss`. More details on customization and themeing can be found in the [customization guide](notes/config.md). - -### How do I add images? -You can put images anywhere in the `/content` folder. - -```markdown -Example image (source is in content/notes/images/example.png) -![Example Image](/content/notes/images/example.png) -``` - -### My Interactive Graph and Backlinks aren't up to date -By default, the `linkIndex.json` (which Quartz needs to generate the Interactive Graph and Backlinks) are not regenerated locally. To set that up, see the guide on [local editing](notes/editing.md) - -### Can I use React/Vue/some other framework? -Not out of the box. You could probably make it work by editing `/layouts/_default/single.html` but that's not what Quartz is designed to work with. 99% of things you are trying to do with those frameworks you can accomplish perfectly fine using just vanilla HTML/CSS/JS. - -## Still Stuck? -Quartz isn't perfect! If you're still having troubles, file an issue in the GitHub repo with as much information as you can reasonably provide. Alternatively, you can message me on [Twitter](https://twitter.com/_jzhao) and I'll try to get back to you as soon as I can. - -🐛 [Submit an Issue](https://github.com/jackyzha0/quartz/issues) diff --git a/content/private/updating.md b/content/private/updating.md deleted file mode 100644 index ef4688e99..000000000 --- a/content/private/updating.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "Updating" -aliases: -- update ---- - -Haven't updated Quartz in a while and want all the cool new optimizations? On Unix/Mac systems you can run the following command for a one-line update! This command will show you a log summary of all commits since you last updated, press `q` to acknowledge this. Then, it will show you each change in turn and press `y` to accept the patch or `n` to reject it. Usually you should press `y` for most of these unless it conflicts with existing changes you've made! - -```shell -make update -``` - -Or, if you don't want the interactive parts and just want to force update your local garden (this assumed that you are okay with some of your personalizations been overriden!) - -```shell -make update-force -``` - -Or, manually checkout the changes yourself. - -> [!warning] Warning! -> -> If you customized the files in `data/`, or anything inside `layouts/`, your customization may be overwritten! -> Make sure you have a copy of these changes if you don't want to lose them. - - -```shell -# add Quartz as a remote host -git remote add upstream git@github.com:jackyzha0/quartz.git - -# index and fetch changes -git fetch upstream -git checkout -p upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss config.toml data -```