pg2es.github.io/config.yaml at master · pg2es/pg2es.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
---
baseURL: "https://pg2es.github.io" # temporary
title: "SearchReplica"
description: >
  Search replica would sync your postgres data to elasticsearch in a background.
theme: "hugo-geekdoc"
publishDir: "docs"

# Required to get well formatted code blocks
pygmentsUseClasses: true
pygmentsCodeFences: true
disablePathToLower: true
enableGitInfo: false

# Required if you want to render robots.txt template
enableRobotsTXT: true

markup:
  goldmark:
    # Needed for mermaid shortcode
    renderer:
      unsafe: true
  tableOfContents:
    startLevel: 1
    endLevel: 9

# taxonomies:
  # tag: tags

params:
  # (Optional, default 6) Set how many table of contents levels to be showed on page.
  # Use false to hide ToC, note that 0 will default to 6 (https://gohugo.io/functions/default/)
  # You can also specify this parameter per page in front matter.
  geekdocToC: 3

  # (Optional, default static/brand.svg) Set the path to a logo for the Geekdoc
  # TODO: make logo
  # relative to your 'static/' folder.
  # geekdocLogo: logo.png

  # (Optional, default false) Render menu from data file in 'data/menu/main.yaml'.
  # See also https://geekdocs.de/usage/menus/#bundle-menu.
  # geekdocMenuBundle: true

  # (Optional, default false) Collapse all menu entries, can not be overwritten
  # per page if enabled. Can be enabled per page via 'geekdocCollapseSection'.
  geekdocCollapseAllSections: false

  # (Optional, default true) Show page navigation links at the bottom of each
  # docs page (bundle menu only).
  geekdocNextPrev: false

  # (Optional, default true) Show a breadcrumb navigation bar at the top of each docs page.
  # You can also specify this parameter per page in front matter.
  geekdocBreadcrumb: false

  # (Optional, default none) Set source repository location. Used for 'Edit page' links. You can also specify this parameter per page in front matter.
  geekdocRepo: "https://github.com/pg2es/pg2es.github.io"

  # (Optional, default none) Enable 'Edit page' links. Requires 'GeekdocRepo' param and the path must point to the parent directory of the 'content' folder. You can also specify this parameter per page in front matter.
  geekdocEditPath: "edit/master/"

  # (Optional, default true) Enables search function with flexsearch. Index is built on the fly and might slow down your website.
  geekdocSearch: false

  # (Optional, default false) Display search results with the parent folder as prefix. This
  # option allows you to distinguish between files with the same name in different folders.
  # NOTE: This parameter only applies when 'geekdocSearch: true'.
  geekdocSearchShowParent: true

  # (Optional, default none) add page to the site footer. It can be either a remote url or a local file path relative to your content directory.
  # geekdocLegalNotice: "/legal"
  # geekdocPrivacyPolicy: "/privacy"

  geekdocAnchor: true # Add an anchor link to headlines.
  geekdocAnchorCopy: true # Copy anchor url to clipboard on click.
  geekdocImageLazyLoading: true # Enable or disable image lazy loading for images rendered by the 'img' shortcode.

  # (Optional, default false) Set HTMl <base> to .Site.BaseURL if enabled. It might be required
  # if a subdirectory is used within Hugos BaseURL.
  # See https://developer.mozilla.org/de/docs/Web/HTML/Element/base.
  geekdocOverwriteHTMLBase: false

  geekdocDarkModeDim: false # Auto-decrease brightness of images and add a slightly grayscale to avoid bright spots while using the dark mode.
  geekdocDarkModeCode: false # Enforce code blocks to always use the dark color theme.

  geekdocBackToTop: true # Display a "Back to top" link in the site footer.
  geekdocTagsToMenu: true # Enable or disable adding tags for post pages automatically to the navigation sidebar.

  # (Optional, default 'title') Configure how to sort file-tree menu entries. Possible options are 'title', 'linktitle',
  # 'date', 'publishdate', 'expirydate' or 'lastmod'. Every option can be used with a reverse modifier as well
  # e.g. 'title_reverse'.
  geekdocFileTreeSortBy: "title"

  # Adds a "Content licensed under <license>" line to the footer.
  # geekdocContentLicense:
    # name: MIT
    # link: https://raw.githubusercontent.com/pg2es/search-replica/master/LICENSE