Welcome to mirror list, hosted at ThFree Co, Russian Federation.

config.yaml « userguide - github.com/google/docsy.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 23aa0b87b47491977802c652737773e913da243b (plain)
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
baseURL: /
title: Docsy Example
enableRobotsTXT: true
theme: [docsy]
enableGitInfo: true

pygmentsCodeFences: true
pygmentsUseClasses: false
pygmentsUseClassic: false
pygmentsStyle: tango

outputs:
  home: [HTML]
  page: [HTML]
  section: [HTML, RSS, print]

imaging:
  resampleFilter: CatmullRom
  quality: 75
  anchor: smart

menu:
  main:
    - name: Example Site
      weight: 40
      url: https://example.docsy.dev
      post: <sup><i class="pl-1 fa-solid fa-up-right-from-square fa-xs"
        aria-hidden="true"></i></sup>

services:
  googleAnalytics:
    id: UA-00000000-0

languages:
  en:
    title: Docsy
    description: Docsy does docs
    languageName: English
    weight: 1

markup:
  goldmark:
    renderer:
      unsafe: true
  highlight:
    style: tango

params:
  copyright: The Docsy Authors
  privacy_policy: https://policies.google.com/privacy
  version_menu: Releases
  archived_version: false
  version: 0.5.1
  url_latest_version: https://example.com
  github_repo: https://github.com/google/docsy
  github_project_repo: https://github.com/google/docsy
  github_subdir: userguide
  time_format_blog: Monday, January 02, 2006
  time_format_default: January 2, 2006
  rss_sections: [blog] # TODO: drop since this is the default
  gcs_engine_id: 011217106833237091527:la2vtv2emlw
  algolia_docsearch: false
  offlineSearch: false
  offlineSearchSummaryLength: 70
  offlineSearchMaxResults: 10
  prism_syntax_highlighting: false
  ui:
    sidebar_menu_compact: true
    sidebar_menu_foldable: false
    sidebar_cache_limit: 10
    breadcrumb_disable: false
    sidebar_search_disable: false
    feedback:
      enable: true
      'yes': >-
        Glad to hear it! Please <a
        href="https://github.com/google/docsy/issues/new">tell us how we can
        improve</a>.
      'no': >-
        Sorry to hear that. Please <a
        href="https://github.com/google/docsy/issues/new">tell us how we can
        improve</a>.
    readingtime:
      enable: false
  links:
    user:
      - name: GitHub Discussions
        url: https://github.com/google/docsy/discussions
        icon: fa-brands fa-github
        desc: Discussion and help from your fellow users
      - name: User mailing list
        url: https://groups.google.com/forum/#!forum/docsy-users
        icon: fa-solid fa-envelope
        desc: Sign up for Docsy announcements
      - name: Twitter
        url: https://twitter.com/docsydocs
        icon: fa-brands fa-twitter
        desc: Follow us on Twitter to get the latest news!
      - name: Stack Overflow
        url: https://stackoverflow.com/questions/tagged/docsy
        icon: fa-brands fa-stack-overflow
        desc: Practical questions and curated answers
    developer:
      - name: GitHub
        url: https://github.com/google/docsy
        icon: fa-brands fa-github
        desc: Development takes place here!

  plantuml:
    enable: true
    theme: default
    svg_image_url: https://www.plantuml.com/plantuml/svg/
    svg: false
  katex:
    enable: true
    html_dom_element: document.body
    mhchem:
      enable: true
  print:
    disable_toc: false
  markmap:
    enable: true

taxonomies:
  tag: tags
  category: categories

module:
  mounts:
    - source: content/en
      target: content