github.com/grpc-ecosystem/grpc-gateway/v2@v2.19.1/docs/_config.yml (about)

     1  # Site settings
     2  # These are used to personalize your new site. If you look in the HTML files,
     3  # you will see them accessed via {{ site.title }}, {{ site.github_repo }}, and so on.
     4  # You can create any custom variable you would like, and they will be accessible
     5  # in the templates via {{ site.myvariable }}.
     6  title: gRPC-Gateway
     7  description: gRPC-Gateway Documentation Website
     8  baseurl: "/grpc-gateway" # the subpath of your site, e.g. /blog
     9  url: "https://grpc-ecosystem.github.io" # the base hostname & protocol for your site, e.g. http://example.com
    10  
    11  repository: grpc-ecosystem/grpc-gateway
    12  remote_theme: pmarsceill/just-the-docs@v0.6.2
    13  
    14  permalink: pretty
    15  exclude: ["run.sh"]
    16  
    17  # Set a path/url to a logo that will be displayed instead of the title
    18  #logo: "/assets/images/grpc-gateway.png"
    19  
    20  # Enable or disable the site search
    21  # Supports true (default) or false
    22  search_enabled: true
    23  search:
    24    # Split pages into sections that can be searched individually
    25    # Supports 1 - 6, default: 2
    26    heading_level: 2
    27    # Maximum amount of previews per search result
    28    # Default: 3
    29    previews: 2
    30    # Maximum amount of words to display before a matched word in the preview
    31    # Default: 5
    32    preview_words_before: 3
    33    # Maximum amount of words to display after a matched word in the preview
    34    # Default: 10
    35    preview_words_after: 3
    36    # Set the search token separator
    37    # Default: /[\s\-/]+/
    38    # Example: enable support for hyphenated search words
    39    tokenizer_separator: /[\s/]+/
    40    # Display the relative url in search results
    41    # Supports true (default) or false
    42    rel_url: true
    43    # Enable or disable the search button that appears in the bottom right corner of every page
    44    # Supports true or false (default)
    45    button: false
    46  
    47  # Enable or disable heading anchors
    48  heading_anchors: true
    49  
    50  # Aux links for the upper right navigation
    51  aux_links:
    52    "gRPC-Gateway on GitHub":
    53      - "https://github.com/grpc-ecosystem/grpc-gateway"
    54  
    55  # Makes Aux links open in a new tab. Default is false
    56  aux_links_new_tab: false
    57  
    58  # Sort order for navigation links
    59  # nav_sort: case_insensitive # default, equivalent to nil
    60  nav_sort: case_sensitive # Capital letters sorted before lowercase
    61  
    62  # Footer content
    63  # appears at the bottom of every page's main content
    64  
    65  # Back to top link
    66  back_to_top: true
    67  back_to_top_text: "Back to top"
    68  
    69  footer_content: 'Copyright &copy; the gRPC-Gateway Authors. Distributed by a <a href="https://github.com/grpc-ecosystem/grpc-gateway/tree/main/LICENSE">BSD 3-Clause License.</a>'
    70  
    71  # Footer last edited timestamp
    72  last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
    73  last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
    74  
    75  # Footer "Edit this page on GitHub" link text
    76  gh_edit_link: true # show or hide edit this page link
    77  gh_edit_link_text: "Edit this page on GitHub"
    78  gh_edit_repository: "https://github.com/grpc-ecosystem/grpc-gateway" # the github URL for your repo
    79  gh_edit_branch: "main" # the branch that your docs is served from
    80  gh_edit_source: docs # the source that your files originate from
    81  gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
    82  
    83  # Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define
    84  color_scheme: nil
    85  
    86  # Disqus Comments
    87  # disqus:
    88  # Leave shortname blank to disable comments site-wide.
    89  # Enable comments for any post by adding `comments: true` to that post's YAML Front Matter.
    90  # shortname:
    91  
    92  # Google Analytics Tracking
    93  # e.g, UA-1234567-89
    94  # ga_tracking:
    95  # ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true/nil by default)
    96  
    97  plugins:
    98    - jekyll-seo-tag
    99    - jekyll-include-cache
   100  
   101  kramdown:
   102    syntax_highlighter_opts:
   103      block:
   104        line_numbers: false
   105  
   106  compress_html:
   107    clippings: all
   108    comments: all
   109    endings: all
   110    startings: []
   111    blanklines: false
   112    profile: false
   113    # ignore:
   114    # envs: all