| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149 |
- baseURL: https://www.docsy.dev/
- title: Docsy
- enableRobotsTXT: true
- enableGitInfo: true
- theme: [docsy]
- ignoreLogs:
- # FIXME: find a better way to encode `project` pages than having to ignore warnings.
- - warning-frontmatter-params-overrides # cSpell:disable-line
- outputs:
- home: [HTML]
- page: [HTML]
- section: [HTML, RSS, print]
- imaging:
- resampleFilter: CatmullRom # cSpell:disable-line
- quality: 75
- anchor: smart
- menu:
- main:
- - name: Example Site
- weight: 40
- url: https://example.docsy.dev
- post: <sup><i class="ps-1 fa-solid fa-up-right-from-square fa-xs"
- aria-hidden="true"></i></sup>
- languages:
- en:
- languageName: English
- params:
- description: Docsy does docs
- markup:
- goldmark:
- parser:
- attribute:
- block: true
- extensions:
- passthrough:
- enable: true
- delimiters:
- block: [['\[', '\]'], ['$$', '$$']]
- inline: [['\(', '\)']]
- renderer:
- unsafe: true
- highlight:
- noClasses: false # Required for dark-mode
- params:
- copyright:
- authors: >-
- Docsy Authors |
- [CC BY 4.0](https://creativecommons.org/licenses/by/4.0) |
- from_year: 2018
- privacy_policy: https://policies.google.com/privacy
- version_menu: Releases
- archived_version: false
- version: 0.12.0
- 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 # cSpell:disable-line
- offlineSearch: false
- offlineSearchSummaryLength: 70
- offlineSearchMaxResults: 10
- prism_syntax_highlighting: false
- search:
- # algolia:
- ui:
- showLightDarkModeMenu: true
- sidebar_cache_limit: 10
- sidebar_menu_compact: true
- sidebar_menu_foldable: 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-x-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: Project info
- url: /project/
- icon: fa fa-book
- desc: Project design documentation and resources
- - 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
- print:
- disable_toc: false
- markmap:
- enable: true
- drawio:
- enable: true
- taxonomies:
- tag: tags
- category: categories
- module:
- mounts:
- - source: content/en
- target: content
- # Mount the repo's top-level .md files under project
- - source: ../README.md
- target: content/project/readme.md
- - source: ../CHANGELOG.md
- target: content/project/changelog.md
- - source: ../CONTRIBUTING.md
- target: content/project/contributing.md
- # cSpell:ignore docsy github goldmark markmap plantuml readingtime userguide
|