mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-03-26 04:54:10 +01:00
608818a06c
The 'Feature Profiles' section of the 'Client-Server API' specification contains a table, showing whether a module is required or optional for every profile. Previously the table was hard to read since "Required" looks visually very similar to "Optional". This commit improves the readability of the table by automatically applying a darker background color to table cells containing "Required" via a new Hugo shortcode. Signed-off-by: Martin Fischer <martin@push-f.com>
116 lines
4.3 KiB
TOML
116 lines
4.3 KiB
TOML
baseURL = "/"
|
|
title = "Matrix Specification"
|
|
|
|
# Prepends absolute URLs with the baseURL. Useful when hosting on non-root
|
|
# paths, such as /unstable.
|
|
canonifyURLs = true
|
|
|
|
enableRobotsTXT = true
|
|
|
|
# Hugo allows theme composition (and inheritance). The precedence is from left to right.
|
|
theme = ["docsy"]
|
|
|
|
# We disable RSS, because (a) it's useless, (b) Hugo seems to generate broken
|
|
# links to it when used with a --baseURL (for example, https://spec.matrix.org/v1.4/
|
|
# contains `<link rel="alternate" type="application/rss+xml" href="/v1.4/v1.4/index.xml">`).
|
|
disableKinds = ["taxonomy", "taxonomyTerm", "RSS"]
|
|
|
|
[languages]
|
|
[languages.en]
|
|
title = "Matrix Specification"
|
|
description = "Home of the Matrix specification for decentralised communication"
|
|
languageName ="English"
|
|
# Weight used for sorting.
|
|
weight = 1
|
|
|
|
[markup]
|
|
[markup.goldmark]
|
|
[markup.goldmark.renderer]
|
|
# Enables us to render raw HTML
|
|
unsafe = true
|
|
[markup.goldmark.parser.attribute]
|
|
block = true # used by the summary-table shortcode
|
|
[markup.highlight]
|
|
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
|
|
# If the style is changed, remember to regenerate the CSS with:
|
|
#
|
|
# hugo gen chromastyles --style=<style> > assets/scss/syntax.scss
|
|
style = "tango"
|
|
|
|
# we enable CSS classes (instead of using inline styles) for compatibility with the CSP.
|
|
noClasses = false
|
|
|
|
# Everything below this are Site Params
|
|
|
|
[params]
|
|
copyright = "The Matrix.org Foundation CIC"
|
|
privacy_policy = "https://matrix.org/legal/privacy-notice"
|
|
|
|
[params.version]
|
|
# must be one of "unstable", "current", "historical"
|
|
# this is used to decide whether to show a banner pointing to the current release
|
|
status = "unstable"
|
|
# A URL pointing to the latest, stable release of the spec. To be shown in the unstable version warning banner.
|
|
current_version_url = "https://spec.matrix.org/latest"
|
|
# The following is used when status = "stable", and is displayed in various UI elements on a released version
|
|
# of the spec. CI will set these values here automatically when a release git tag (i.e `v1.5`) is created.
|
|
# major = "1"
|
|
# minor = "7"
|
|
# release_date = "May 25, 2023"
|
|
|
|
# User interface configuration
|
|
[params.ui]
|
|
# Set to true to disable the About link in the site footer
|
|
footer_about_disable = false
|
|
# Collapse HTTP API and event <details> elements
|
|
rendered_data_collapsed = false
|
|
# Hide the search entry in the sidebar
|
|
sidebar_search_disable = true
|
|
# Only show the current page's ancestors, siblings and direct descendants in the sidebar menu
|
|
sidebar_menu_compact = true
|
|
|
|
[params.links]
|
|
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
|
|
# [[params.links.user]]
|
|
# name = "User mailing list"
|
|
# url = "https://example.org/mail"
|
|
# icon = "fa fa-envelope"
|
|
# desc = "Discussion and help from your fellow users"
|
|
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
|
|
[[params.links.developer]]
|
|
name = "GitHub"
|
|
url = "https://github.com/matrix-org"
|
|
icon = "fab fa-github"
|
|
desc = "Matrix on GitHub"
|
|
[[params.links.developer]]
|
|
name = "GitLab"
|
|
url = "https://gitlab.matrix.org/matrix-org"
|
|
icon = "fab fa-gitlab"
|
|
desc = "Matrix on GitLab"
|
|
[[params.links.developer]]
|
|
name = "YouTube"
|
|
url = "https://www.youtube.com/channel/UCVFkW-chclhuyYRbmmfwt6w"
|
|
icon = "fab fa-youtube"
|
|
desc = "Matrix YouTube channel"
|
|
[[params.links.developer]]
|
|
name = "Twitter"
|
|
url = "https://twitter.com/matrixdotorg"
|
|
icon = "fab fa-twitter"
|
|
desc = "Matrix on Twitter"
|
|
|
|
|
|
# configuration for the hugo development server
|
|
[server]
|
|
|
|
# set HTTP response headers to match the production site. Compare the Apache config for `spec.matrix.org`.
|
|
[[server.headers]]
|
|
for = '/**'
|
|
[server.headers.values]
|
|
Content-Security-Policy = "default-src 'self'; style-src 'self'; script-src 'self'; img-src 'self' data:; connect-src 'self'; font-src 'self' data:; media-src 'self'; child-src 'self'; form-action 'self'; object-src 'self'"
|
|
X-XSS-Protection = "1; mode=block"
|
|
X-Content-Type-Options = "nosniff"
|
|
# Strict-Transport-Security = "max-age=31536000; includeSubDomains; preload"
|
|
X-Frame-Options = "sameorigin"
|
|
Access-Control-Allow-Origin = "*"
|
|
Access-Control-Allow-Methods = "GET"
|