Simple second brain and digital garden .
Hosting a public digital garden isn’t easy. There are an overwhelming number of tutorials, resources, and guides for tools like @@ -12,4 +12,4 @@ and Joel ’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.
The entire Quartz documentation is fully hosted using Quartz! To get started, let’s visit the main directory.
👉 -Directory
Welcome to Quartz! Whether you’re setting up a website and project for the first time or a seasoned digital gardener, I hope that you’ll find something useful about this project.
Let’s get to business and get you started!
Want to see what Quartz can do? Here are some cool community gardens :)
If you want to see your own on here, submit a Pull Request adding yourself to this file -!
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.
|
Want to go even more in-depth? You can add custom CSS styling and change existing colours through editing assets/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 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.
Still having problems? Checkout our FAQ and Troubleshooting guide -.
Quartz runs on top of Hugo so all notes are written in @@ -25,5 +25,5 @@ Rest of your content here... Preview Quartz Changes
For those who like to live life more on the edge, viewing the garden through Obsidian gets you pretty close to the real thing.
Now that you know the basics of managing your digital garden using Quartz, you can publish it to the internet!
Having problems? Checkout our FAQ and Troubleshooting guide -.
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! You can head to <YOUR-GITHUB-USERNAME.github.io/quartz to see it live.
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
Head to the ‘Settings’ tab of your forked repository and go to the ‘Pages’ tab.
master using / (root)
Enable GitHub Pages
To see your changes on the internet, we need to push it them to GitHub. Quartz is essentially a git repository so updating it is the same workflow as you would follow as normal.
|
Setting up Quartz requires a basic understanding of git. If you are unfamiliar,
this resource
is a great place to start!
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:
📁 @@ -11,5 +11,5 @@ is a great place to start!
A fork i
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.
Having problems? Checkout our FAQ and Troubleshooting guide -.
Yes! Quartz makes selective publishing really easy. Heres a guide on excluding pages from being published .
Yes! All built files can be found under /public in the master branch. More details under
@@ -31,5 +31,5 @@ again. Make sure you wait 30 min to 1 hour for changes to take effect.
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.
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 and I’ll try to get back to you as soon as I can.
Example Configuration for Quartz
Obsidian Settings