From 69e42886a6a7e094577618f4b37c6dde3b540c1d Mon Sep 17 00:00:00 2001 From: jackyzha0 <j.zhao2k19@gmail.com> Date: Sun, 18 Jul 2021 20:40:53 +0000 Subject: [PATCH] flesh out docs --- content/notes/config.md | 43 ++++++++++++++++++++++++++++++++++++++++--- 1 files changed, 40 insertions(+), 3 deletions(-) diff --git a/content/notes/config.md b/content/notes/config.md index 89e7d8d..f701473 100644 --- a/content/notes/config.md +++ b/content/notes/config.md @@ -2,7 +2,44 @@ title: "Configuration" --- +## 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 +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 +paths: # colour specific nodes path off of their path + - /moc: "#4388cc" +``` + + ## Styling -## Layouts -### Home Page -### Partials \ No newline at end of file +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 +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). \ No newline at end of file -- Gitblit v1.10.0