docs: polish and update

content/notes/config.md

@@ -2,6 +2,7 @@
 title: "Configuration"
 tags:
 - setup
+weight: 5
 ---
 
 ## Configuration
@@ -10,13 +11,49 @@ Quartz is designed to be extremely configurable. You can find the bulk of the co
 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
+# The name to display in the footer
+name: Jacky Zhao
 
-links: # Links to show in footer
+# 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 try to process Latex
+enableLatex: true
+
+# whether to enable single-page-app style rendering
+# this prevents flahses of unstyled content and overall 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
+
+# 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:
+  "🪴 Quartz 3.2"
+
+# links to show in the footer
+links:
   - link_name: Twitter
     link: https://twitter.com/_jzhao
   - link_name: Github
@@ -24,14 +61,6 @@ links: # Links to show in footer
 ```
 
 ### HTML Favicons
-
-A Favicon is most commonly seen as the **image preceding the URL in a browser**. 
-Some other examples include (but are not limited to) bookmarks, search history, 
-and app icons (i.e. "save page to home screen" on mobile devices).
-[File format support](https://en.wikipedia.org/wiki/Favicon#File_format_support)
-and the [use of favicons](https://en.wikipedia.org/wiki/Favicon#Use_of_favicon) 
-differ across the combination of platforms and browsers.
-
 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:
@@ -50,11 +79,7 @@ favicon:
 #  - { ... } # Repeat for each additional favicon you want to add
 ```
 
-In this format, the following keys are available:
-- `rel`: The `rel` attribute of the `<link>` tag.
-- `type`: The `type` attribute of the `<link>` tag.
-- `href` (optional): The `href` attribute of the `<link>` tag.
-- `sizes` (optional): The `sizes` attribute of the `<link>` tag.
+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 
@@ -71,17 +96,6 @@ 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/).
 
-Some websites that **generate favicons** for you (ordered alphabetically) include:
-- [`favicon.io`](https://favicon.io/)
-- [`realfavicongenerator.net`](https://realfavicongenerator.net/)
-- [`www.favicon.cc`](https://www.favicon.cc/)
-
-These sites will take a base image and generate a set of favicons for you, 
-one of which will be, for example, the `apple-touch-icon` favicon. These sites
-will often **also provide the HTML** for the favicon, which can be simply 
-added to the `data/config.yaml` using the HTML format of the `favicon` 
-argument. 
-
 **Note** that all generated favicon paths, defined by the `href` 
 attribute, are relative to the `static/` directory.
 
@@ -89,11 +103,50 @@ attribute, are relative to the `static/` directory.
 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
+# 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"
 ```
 
@@ -110,7 +163,7 @@ More info about partials on [Hugo's website.](https://gohugo.io/templates/partia
 
 Still having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).
 
-## Multilingual
+## 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.