Johannes Marbach
1c2e58d66f
Use relative path for pagefind JS
...
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-03-24 10:17:37 +01:00
Andrew Morgan
2fd3c28a7a
Attempt to fix page jump upon expanding search results
2026-03-20 12:54:14 +00:00
Johannes Marbach
15f36d1934
Only use plural of 'results' when actually necessary
...
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2026-03-20 13:44:11 +01:00
Johannes Marbach
9edb9b3e5b
Add triangle indicator on expander buttons and remove left margins
...
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2026-03-20 13:38:12 +01:00
Johannes Marbach
94fca47a7d
Add total number of subresults per main result
...
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2026-03-20 13:37:41 +01:00
Johannes Marbach
a56969149f
Stop bluring the input
...
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2026-03-20 13:18:36 +01:00
Johannes Marbach
72205be3dc
Set cursor style and a11y label on close button
...
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2026-03-20 13:13:05 +01:00
Johannes Marbach
8e383835b9
Toggle expander label between show and hide
...
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2026-03-20 13:08:53 +01:00
Johannes Marbach
92b7e714e7
Add loading spinner while the search is running
...
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2026-03-20 12:52:01 +01:00
Johannes Marbach
9a1b7ffa7c
Group subresults
...
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2026-03-19 08:50:45 +01:00
Johannes Marbach
7dfd746e06
Remove leftovers
...
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2026-03-17 13:21:42 +01:00
Johannes Marbach
b3d4f9a96e
Change to using Pagefind via the built-in Docsy search UI
...
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2026-03-17 13:04:43 +01:00
Johannes Marbach
fdd2a9abe8
Add page search widget
...
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2026-03-06 15:25:50 +01:00
Kévin Commaille
c47fa4d093
Bump docsy to v0.13.0 ( #2287 )
...
Spec / 🔎 Validate OpenAPI specifications (push) Waiting to run
Spec / 🔎 Check Event schema examples (push) Waiting to run
Spec / 🔎 Check OpenAPI definitions examples (push) Waiting to run
Spec / 🔎 Check JSON Schemas inline examples (push) Waiting to run
Spec / ⚙️ Calculate baseURL for later jobs (push) Waiting to run
Spec / 🐍 Build OpenAPI definitions (push) Blocked by required conditions
Spec / 📢 Run towncrier for changelog (push) Waiting to run
Spec / 📖 Build the spec (push) Blocked by required conditions
Spec / 🔎 Validate generated HTML (push) Blocked by required conditions
Spec / 📖 Build the historical backup spec (push) Blocked by required conditions
Spec / Create release (push) Blocked by required conditions
Spell Check / Spell Check with Typos (push) Waiting to run
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2026-01-15 17:01:07 +00:00
Andrew Morgan
9e959f3922
Add a list of endpoints to the top of each spec ( #2262 )
...
Fixes #784
Add a collapsible list of endpoints to the top of the page for each distinct spec. We do this by storing endpoint metadata on $page and creating a new partial, endpoints-toc.html, which renders it.
2025-12-18 14:59:18 +00:00
Kévin Commaille
54944e2866
Fix version selector's historical URL ( #2268 )
...
Spec / 🔎 Validate OpenAPI specifications (push) Waiting to run
Spec / 🔎 Check Event schema examples (push) Waiting to run
Spec / 🔎 Check OpenAPI definitions examples (push) Waiting to run
Spec / 🔎 Check JSON Schemas inline examples (push) Waiting to run
Spec / ⚙️ Calculate baseURL for later jobs (push) Waiting to run
Spec / 🐍 Build OpenAPI definitions (push) Blocked by required conditions
Spec / 📢 Run towncrier for changelog (push) Waiting to run
Spec / 📖 Build the spec (push) Blocked by required conditions
Spec / 🔎 Validate generated HTML (push) Blocked by required conditions
Spec / 📖 Build the historical backup spec (push) Blocked by required conditions
Spell Check / Spell Check with Typos (push) Waiting to run
* Fix version selector's historical URL
Regression because the function signature changed in #2261 , but this
call was not updated.
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Add changelog
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
---------
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2025-12-16 10:11:47 -07:00
Johannes Marbach
13aa6e83ae
Use more specific names for the version picker CSS classes and add them to the PurgeCSS safelist ( #2264 )
Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled
Spec / 🔎 Check Event schema examples (push) Has been cancelled
Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled
Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled
Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled
Spec / 📢 Run towncrier for changelog (push) Has been cancelled
Spell Check / Spell Check with Typos (push) Has been cancelled
Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled
Spec / 📖 Build the spec (push) Has been cancelled
Spec / 🔎 Validate generated HTML (push) Has been cancelled
Spec / 📖 Build the historical backup spec (push) Has been cancelled
2025-12-05 18:06:17 +00:00
Andrew Morgan
705240da72
Prevent PurgeCSS from deleting dynamically-added version picker CSS classes ( #2260 )
2025-12-05 15:19:24 +00:00
Johannes Marbach
4dbe080570
Append version number to 'latest' entry in the picker ( #2261 )
2025-12-05 14:12:05 +00:00
Johannes Marbach
7a1eb81c9c
Fix versions.json URL in unstable and local environment ( #2259 )
2025-12-05 12:10:18 +00:00
Johannes Marbach
22c0952003
Load versions.json as a resource if we're in the unstable spec ( #2258 )
...
Spec / 🔎 Validate OpenAPI specifications (push) Waiting to run
Spec / 🔎 Check Event schema examples (push) Waiting to run
Spec / 🔎 Check OpenAPI definitions examples (push) Waiting to run
Spec / 🔎 Check JSON Schemas inline examples (push) Waiting to run
Spec / ⚙️ Calculate baseURL for later jobs (push) Waiting to run
Spec / 🐍 Build OpenAPI definitions (push) Blocked by required conditions
Spec / 📢 Run towncrier for changelog (push) Waiting to run
Spec / 📖 Build the spec (push) Blocked by required conditions
Spec / 🔎 Validate generated HTML (push) Blocked by required conditions
Spec / 📖 Build the historical backup spec (push) Blocked by required conditions
Spell Check / Spell Check with Typos (push) Waiting to run
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-12-04 11:25:07 -07:00
Johannes Marbach
a5afe542c0
Add version picker in the navbar ( #2256 )
...
Spec / 🔎 Validate OpenAPI specifications (push) Waiting to run
Spec / 🔎 Check Event schema examples (push) Waiting to run
Spec / 🔎 Check OpenAPI definitions examples (push) Waiting to run
Spec / 🔎 Check JSON Schemas inline examples (push) Waiting to run
Spec / ⚙️ Calculate baseURL for later jobs (push) Waiting to run
Spec / 🐍 Build OpenAPI definitions (push) Blocked by required conditions
Spec / 📢 Run towncrier for changelog (push) Waiting to run
Spec / 📖 Build the spec (push) Blocked by required conditions
Spec / 🔎 Validate generated HTML (push) Blocked by required conditions
Spec / 📖 Build the historical backup spec (push) Blocked by required conditions
Spell Check / Spell Check with Typos (push) Waiting to run
Co-authored-by: Andrew Morgan <andrew@amorgan.xyz>
2025-12-04 12:24:28 +00:00
Johannes Marbach
4cafe7d9f4
Include Olm & Megolm specifications in main spec ( #2226 )
...
Fixes : #1543
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-10-31 10:33:32 +00:00
Kévin Commaille
81273df88e
Adjust margins in rendered endpoints ( #2081 )
...
Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled
Spec / 🔎 Check Event schema examples (push) Has been cancelled
Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled
Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled
Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled
Spec / 📢 Run towncrier for changelog (push) Has been cancelled
Spell Check / Spell Check with Typos (push) Has been cancelled
Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled
Spec / 📖 Build the spec (push) Has been cancelled
Spec / 🔎 Validate generated HTML (push) Has been cancelled
Spec / 📖 Build the historical backup spec (push) Has been cancelled
* Use consistent spacing between tables and code blocks
Tables used `4 rem` which is more than the margin above a h2 title, which seems excessive. We change it to `2 rem` which matches the margin of code blocks and info boxes.
We also remove the margin on the last item of a `.rendered-data` block because this is just wasted space.
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Adjust spacing around h2 and h3 titles in `.rendered-data`
Given that h2 titles are always preceded by an horizontal rule, we don't need a lot of space to separate them from the previous section.
We also reduce the spacing when a h2 title is followed directly by a h3 title.
Finally, we add a little spacing below both so that tables are less close to the title.
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Add changelog
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
---------
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2025-04-15 18:35:27 +01:00
Kévin Commaille
b4c52ab7bd
Use a proper favicon ( #2001 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-11-19 22:08:45 +00:00
Kévin Commaille
0657cc1848
Fix error in ToC script at the bottom of the page ( #2002 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-11-19 22:06:20 +00:00
Kévin Commaille
0ce83512fc
Update Inter font and set display: swap ( #2000 )
...
The version of Inter is updated to use a variable font, which is supported widely among modern browsers.
Using `display: swap` means that the browser will render the text of the spec even before Inter is loaded, making the website appear to load faster on mobile.
Allow the browser to use the local Inter font if it exists.
2024-11-19 22:01:27 +00:00
Kévin Commaille
9882d95775
Improve the quality of the rendered diagrams ( #1999 )
...
The first commit allows to lazy-load the diagrams, which should improve the loading time of the CS API on mobile. In the process it also improves the alt text of the images.
The second commit serves the diagrams as high-resolution WebPs. Encoding a high resolution diagram as WebP gives a file of approximately the same size as the lower resolution PNG. For maximum compatibility we also serve them as a lower resolution WebP and a fallback PNG. WebP was chosen because it is one of the export formats of draw.io/diagrams.net, and it is widely available in modern browsers.
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-11-19 21:41:45 +00:00
Kévin Commaille
d5c56a4f17
Upgrade docsy to 0.11.0 and hugo to 0.139.0 ( #1996 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-11-19 21:40:34 +00:00
Kévin Commaille
bf8dee74eb
Fix relative URLs when serving the specification with a custom baseURL ( #1984 )
2024-11-14 11:11:34 +00:00
Kévin Commaille
3b8f3a09aa
Remove CSS workaround for scroll-anchoring ( #1976 )
...
Docsy does not set the `height` anymore, but the `min-height`, which doesn't seem to affect scroll-anchoring.
See f22a70ec56
2024-10-29 22:58:53 +00:00
Kévin Commaille
1f5f2c4d83
Enforce consistent vertical spacing between paragraphs in endpoint definitions ( #1969 )
...
Use `p` elements to separate paragraphs instead of `br` and enforce single paragraphs to be wrapped in `p` for consistency.
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-10-29 15:22:15 +00:00
Kévin Commaille
1e47d7ec48
Remove boxes/added-in-paragraph shortcode ( #1970 )
2024-10-14 17:57:33 +01:00
Johannes Marbach
215982abc2
Use dedicated fonts for better support of mathematical symbols ( #1919 )
2024-08-19 13:11:05 +01:00
Johannes Marbach
ee1a169121
Arrange rows in .basic-info tables vertically when horizontal space is constrained ( #1771 )
...
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2024-04-09 13:31:46 +00:00
Johannes Marbach
8ff3623e37
Reduce whitespace on mobile viewports ( #1770 )
...
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2024-03-27 09:55:01 +00:00
Kévin Commaille
6700f5ddd1
Disable smooth scrolling ( #1762 )
...
It was not enabled before the docsy update and it messes with
the TOC highlighting during the transition.
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-03-21 11:03:07 +00:00
Kévin Commaille
b136b357e0
Update docsy to v0.8.0 ( #1699 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-02-27 18:12:39 +00:00
Martin Fischer
1a11a7b998
Use auto table-layout on desktop ( #1601 )
...
Signed-off-by: Martin Fischer <martin@push-f.com>
2023-07-20 07:23:16 +00:00
Kévin Commaille
a6eb381ebb
Fix the sidebar in recent versions of Hugo ( #1551 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2023-06-27 22:24:22 +01:00
Kévin Commaille
564444d43e
Render binary request and response bodies ( #1579 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2023-06-20 18:33:06 +01:00
David Robertson
f9ea0f9d9b
Only include endpoint path in <summary> ( #1446 )
2023-03-02 16:58:04 +00:00
Richard van der Hoff
a9e9202e89
Load Inter CSS directly ( #1444 )
...
Move the load of the Inter font CSS from _variables_project.scss to head-end.html.
Empirically, this seems to fix #965
2023-02-28 14:56:19 +00:00
David Robertson
07442876ce
Improve presentation of push rules kinds and actions ( #1348 )
2022-11-22 16:01:23 +00:00
Andrew Morgan
fd41d9d4ed
Update docsy (hugo theme) git submodule ( #1295 )
2022-11-08 17:29:10 +00:00
Travis Ralston
afc0e6a026
Add CORP headers to media repo ( #1197 )
...
* Add CORP headers to media repo
MSC: https://github.com/matrix-org/matrix-spec-proposals/pull/3828
* Write weird CSS rules to make added-in work inline in the CS spec
Even though our content doesn't need 2 paragraphs, it's good to have the capability to render it in the future.
* Remove test paragraph
* Refine prose
* spelling is key
2022-08-09 10:44:51 -06:00
Richard van der Hoff
ef384f1afd
Give rendered-data sections a background and some padding ( #1195 )
...
Gives definition sections for APIs, events, etc a background and a small indent, which I find very helpful to guide the eye.
2022-08-04 09:46:11 +00:00
Richard van der Hoff
dc4fd9bdd6
Render HTML anchors for definition blocks ( #1191 )
...
It's handy to be able to link to these.
2022-08-03 07:28:47 +01:00
Richard van der Hoff
b58c7a5839
Reinstate margin between tables ( #1192 )
2022-08-02 23:47:57 +01:00
David Robertson
69ff51c017
Tweak style of <code> samples in rendered tables ( #1179 )
...
* Tweak style of `<code>` samples in rendered tables
This has been subtly irritating me for aaaaaaages
* Changelogs
2022-08-02 14:49:27 +01:00
