1# © 2020 and later: Unicode, Inc. and others. 2# License & terms of use: http://www.unicode.org/copyright.html 3 4title: ICU Documentation 5email: icu-support@icu-project.org 6description: >- # this means to ignore newlines until "baseurl:" 7 ICU is a mature, widely used set of C/C++ and Java libraries providing Unicode 8 and Globalization support for software applications. The ICU User Guide provides 9 documentation on how to use ICU. 10 11baseurl: "/icu" # the subpath for the site 12url: "https://unicode-org.github.io" # the base hostname & protocol for your site 13 14twitter_username: unicode 15github_username: unicode-org 16 17remote_theme: pmarsceill/just-the-docs 18 19# GitHub uses its own markdown renderer called CommonMarkGhPages. 20# 21# To use this we'd need to set the following options: 22# markdown: CommonMarkGhPages 23# Plugins: 24# jekyll-commonmark-ghpages 25# 26# commonmark: 27# options: ["SMART", "FOOTNOTES"] 28# extensions: ["strikethrough", "autolink", "table", "tagfilter"] 29# 30# However, it doesn't work well with Jekyll and the Just-The-Docs theme, 31# and causes too many formatting problems. Additionally, it also doesn't 32# have any support for auto-generating a Table of Contents (TOC) section 33# for a page. Due to these reasons, we instead use the recommended 34# markdown renderer for Jekyll, called kramdown. 35# 36markdown: kramdown 37 38# Notes on plugins: 39# - GitHub Pages ignores all plugins included in the Gemfile. 40# - Only the ones listed in the _config.yml file (this file) are used. 41# - There is a very limited set of plugins that GH Pages supports (for security 42# reasons). The listing is here: https://pages.github.com/versions 43# - The jekyll-sitemap plugin generates a "sitemap.xml" for search engines. 44# - We need the "jemoji" plugin for rendering emoji like ":point_right:". 45plugins: 46 - jekyll-remote-theme 47 - jekyll-sitemap 48 - jemoji 49 50search_enabled: true 51 52# Color scheme currently only supports "dark" or nil (light). 53color_scheme: nil 54 55# Aux links for the upper right navigation 56aux_links: 57 "API Docs": 58 - "https://unicode-org.github.io/icu-docs" 59 "ICU on GitHub": 60 - "https://github.com/unicode-org/icu" 61 "ICU Home Page": 62 - "http://site.icu-project.org/" 63 "Unicode Home Page": 64 - "https://www.unicode.org" 65 66# Makes Aux links open in a new tab. 67aux_links_new_tab: true 68 69# Add a "Back to top" link at the bottom of each page. 70back_to_top: true 71back_to_top_text: "Back to top" 72 73# Enable heading anchors 74heading_anchors: true 75 76# Footer content: appears at the bottom of every page after the main content. 77footer_content: "© 2016 and later: Unicode, Inc. and others. License & terms of use: <a href=\"http://www.unicode.org/copyright.html\">http://www.unicode.org/copyright.html</a>" 78 79# Footer content: Add a "Edit this page on GitHub" link. 80# Note: I think this would be better at the *top* of the page, but it isn't possible to do that by default with just-the-docs. 81gh_edit_link: true # show or hide edit this page link 82gh_edit_link_text: "Edit this page on GitHub." 83gh_edit_repository: "https://github.com/unicode-org/icu" 84# NOTE: Since we serve the docs out of the "docs" folder, we need to include that here even though 85# it is technically *not* part of the branch name. 86gh_edit_branch: "main/docs" 87# Can be "tree" or "edit". Edit takes the user to jump into the editor immediately. 88gh_edit_view_mode: "tree" 89 90# Exclude from processing. 91# Excluded items can be processed by explicitly listing the directories or 92# their entries' file path in the `include:` list. 93exclude: 94 - Gemfile 95 - Gemfile.lock 96 97# Google Analytics 98ga_tracking: UA-7670256-1 99ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings 100