Compare commits

..

99 Commits

Author SHA1 Message Date
Patrice Chalin 55db259b4d
ScrollSpy: drop smooth scrolling (#2291) 2025-06-13 20:18:28 -04:00
Patrice Chalin 3a5cfeada3
Refine scrollspy style and behavior (#2290) 2025-06-13 19:06:18 -04:00
Patrice Chalin 4323d098da
Add support for BS ScrollSpy to show active TOC entry (#2287) 2025-06-13 08:01:45 -04:00
Patrice Chalin aa0f617ff7
Accessibility color fixes, and falling back to BS defaults for typography and color (#2285)
Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>
2025-06-13 07:30:56 -04:00
Patrice Chalin f8f02e7abe
Update package.json, Hugo to 0.147.8 (#2286) 2025-06-12 19:14:58 -04:00
Patrice Chalin b3e4ccf8a8
A better alert shortcode more markdown friendly (#941) 2025-06-12 08:10:11 -04:00
Patrice Chalin 433ddb6a67
UG cleanup of alert calls: drop color when set to default (#2282) 2025-06-10 18:56:22 -04:00
Andreas Deininger a824b2a51d
Shortcode 'card': trimming of whitespace (#2278) 2025-06-05 15:00:01 -04:00
Patrice Chalin 614e7ec541
Update package.json: use NPM vers of Node (#2275) 2025-06-01 05:49:24 -04:00
Patrice Chalin db526c5963
Hugo and Netlify NPM pkgs: update & change to peer; update UG (#2274) 2025-05-31 07:34:17 -04:00
ensag-dev 627a0df8a6
i18n: adds Occitan locale (#2173) 2025-05-27 12:47:24 -04:00
Patrice Chalin 0f055744e5
Set NPM package version to next unreleased dev version 0.12.1-dev (#2269) 2025-05-27 12:42:30 -04:00
Patrice Chalin ace4e37cee
Release v0.12.0 preparation (#2265) 2025-05-27 10:42:33 -04:00
Patrice Chalin 706f2c81cb
Update min Hugo version in theme config, and some UG copyedits (#2267) 2025-05-27 10:00:54 -04:00
Andreas Deininger dbfb6c40a4
User guide, LaTeX: typesetting of formulae using standard syntax (II) (#2195) 2025-05-27 09:33:16 -04:00
chrish 1d490986dd
i18n Norwegian: Added missing key, updated translations (#2186)
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
2025-05-27 08:23:51 -04:00
Patrice Chalin bed4f25de4
Streamline README.md and other copyedits (#2264) 2025-05-27 06:26:00 -04:00
jorado 5d2f05f2af
Use font-weight-bold variable (#2234)
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
2025-05-27 05:55:31 -04:00
luigicaetano b40e075a25
i18n PT-BR: Added missing key, updated translations (#2233)
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
2025-05-27 05:30:57 -04:00
Attila Greguss f15d519ea5
Update Swagger UI to 5.21.0 (latest) (#2252) 2025-05-27 05:29:43 -04:00
Jack Arton 27f37fdd34
Update Ukrainian translation file (uk.toml): fixed errors, added missing keys, unified tone (#2248) 2025-05-27 05:26:48 -04:00
Andreas Deininger b999711cec
Linting of .scss files (#2253) 2025-05-27 04:47:31 -04:00
Patrice Chalin 84af4401a3
Update Hugo to 0.147.5 (#2263) 2025-05-27 04:23:47 -04:00
Patrice Chalin 89bd75149f
Config file misc clean up and refcache update (#2262) 2025-05-23 09:15:30 -04:00
Patrice Chalin b8366110d7
Make content-after-header a layout fragment again (#2261) 2025-05-23 08:30:01 -04:00
Patrice Chalin 4939576fd7
Changelog updates for layout refactorings (#2260) 2025-05-23 07:04:53 -04:00
Patrice Chalin b8d1d51369
Rename layout fragment to include `_td` prefix (#2259) 2025-05-22 19:08:56 -04:00
Andreas Deininger 3b258a5afd
User guide: minor improvements (#2258) 2025-05-22 16:43:06 -04:00
Patrice Chalin ef2f9a91ef
Move taxonomy and terms out of _default (#2257) 2025-05-22 16:05:52 -04:00
Patrice Chalin dc6a30a9df
Move new content-after-header hook into partials folder, add UG entry (#2256) 2025-05-22 13:50:29 -04:00
Patrice Chalin 044322e98f
Moving some files out of `layouts/_default`, and using `all.html` (#2255) 2025-05-22 12:23:04 -04:00
Patrice Chalin e59079dc9e
Update NPM pkgs, Hugo to 0.147.4 (#2254) 2025-05-22 11:28:53 -04:00
Patrice Chalin 4b905d3047
Drop `_internal` prefix from template paths (#2250) 2025-05-22 11:12:41 -04:00
Andreas Deininger 47fd135c4b
User guide: fix wrong file name, update version information (#2251) 2025-05-16 11:16:13 -04:00
Patrice Chalin 126685e3d0
Check all external links, fix broken links (#2249) 2025-05-16 10:19:02 -04:00
Patrice Chalin 90854cc4f5
Add underscore to `partials` and `shortcodes` directory names (#2247) 2025-05-16 08:58:32 -04:00
Patrice Chalin dba24fe5e3
Move layouts/_default/_markup one level up, adjusts UG (#2246) 2025-05-16 07:00:24 -04:00
Patrice Chalin 619fd0c5a9
[UG] Run Prettier over all pages under `adding-content` (#2244) 2025-05-16 06:31:30 -04:00
Patrice Chalin 8e5229130c
Update packages, Hugo to 0.147.3 (#2242) 2025-05-16 04:51:11 -04:00
Andreas Deininger bccd7eadc3
Cleanup: drop temporary GA template (#2237) 2025-05-14 14:25:08 -04:00
Patrice Chalin c52e543b26
Update Bootstrap to 5.3.6 (#2240) 2025-05-14 08:48:10 -04:00
Patrice Chalin 031b7aad82
Update Hugo to 0.147.2, and netlify-cli (#2239) 2025-05-14 07:12:53 -04:00
Patrice Chalin 62273b980e
Enable blank issue template (#2231) 2025-05-01 20:07:14 -04:00
Patrice Chalin f4ea6a1ebd
[UG] Taxonomy page copyedited & prettified (#2229) 2025-04-28 19:34:16 -04:00
Patrice Chalin c2e4beb5d7
Update pkgs: Hugo to 0.147.0, etc (#2228) 2025-04-26 12:41:56 -04:00
Andreas Deininger d6e9f38cd1
User guide: remove deprecated kind 'taxonomyterm' from disableKinds (#2227) 2025-04-26 12:13:49 -04:00
Patrice Chalin 343cdec14c
Rename Docsy's render-heading hook and helper partial (#2223) 2025-04-24 08:14:10 -04:00
Andreas Deininger 9b1fda9652
Bump dependency bootstrap to latest released version 5.3.5 (#2222) 2025-04-23 19:11:38 -04:00
Andreas Deininger 2903fcdcd6
Fix typo (#2219) 2025-04-23 19:07:48 -04:00
Andreas Deininger bd2bf128cc
user guide: fix preview with latest hugo version 0.146.5 (#2215) 2025-04-23 19:07:25 -04:00
nate contino a93bab7b9d
Replace 404'd link to cross reference docs with API reference for relref (#2217) 2025-04-15 10:34:16 -07:00
Patrice Chalin 3b8482557b
Heading render hook: support all attributes (#2206) 2025-03-21 15:59:14 -04:00
Patrice Chalin dc1121eb48
Update NPM pkgs, Hugo to 0.145.0 (#2204) 2025-03-19 12:49:43 -04:00
Patrice Chalin d95df6db54
[UG] Run Prettier over search.md page (#2203) 2025-03-19 11:13:45 -04:00
Patrice Chalin 86b4f3a096
[UG] Explain how to implement custom search (#2202) 2025-03-18 14:21:08 -04:00
Patrice Chalin cbc714bed7
Add link def to CHANGELOG and clean up whitespace (#2193) 2025-02-10 15:59:25 -05:00
Patrice Chalin 2239156975
[feat] Add base support of td-content-after-header hook (#2192) 2025-02-10 15:30:51 -05:00
Patrice Chalin da8cab3a0f
Upgrade Hugo to 0.143.1, etc (#2191) 2025-02-10 04:46:55 -05:00
Patrice Chalin bf5e26c8ff
Revert "UG LaTeX: typesetting of formulae using standard syntax (#1858)" (#2190) 2025-02-10 04:25:04 -05:00
Andreas Deininger 9815271015
User guide, LaTeX: typesetting of formulae using standard syntax (#1858)
undefined
2025-02-06 17:43:14 -05:00
Patrice Chalin 9e685592bb
Upgrade Hugo to 0.143.0 and add comment shortcode (#2188) 2025-02-04 13:13:02 -05:00
Patrice Chalin 77da7e4943
Fix language-drop style when in left nav (#2183) 2025-01-30 06:08:47 -05:00
Patrice Chalin a854cb315a
Update Hugo to 0.142.0, and more (#2182) 2025-01-23 20:21:54 -05:00
Andreas Deininger 7b3eaa40ae
Remove docsy's custom shortcode 'figure' (#2175) 2025-01-21 15:28:01 -05:00
Patrice Chalin 258d3e51ca
Drop style attribute using undef CSS var (#2180) 2025-01-21 14:48:14 -05:00
Patrice Chalin ef59ee75d9
[CI] Upgrade NPM packages (#2179) 2025-01-20 17:47:51 -05:00
Andreas Deininger 9c414904c5
Fix error when building user guide with latest hugo version 0.141.0 (#2177) 2025-01-20 17:29:41 -05:00
Patrice Chalin e6d94771f3
Breadcrumb for blog pages, and per-page/section config (#2161) 2025-01-10 11:30:19 -05:00
Andreas Deininger 9fbb3a6676
Bump KaTeX to latest version (#2168) 2025-01-09 16:10:40 -05:00
Peter Dave Hello a9ea2b7860
Update and improve zh-TW Traditional Chinese locale (#2158)
Co-authored-by: ChengHao Yang <tico88612@gmail.com>
2025-01-09 11:51:45 -05:00
Patrice Chalin 1b3fc5a72f
Userguide config cleanup, drop pygments config (#2166) 2025-01-09 08:47:53 -05:00
Patrice Chalin 88ec5aef5d
Render-heading: process class attributes (#2165) 2025-01-09 08:40:44 -05:00
Patrice Chalin dd5e69b4d6
Hide index-page single breadcrumb (#2160) 2025-01-08 12:46:18 -05:00
Patrice Chalin 30a6c3426e
Blog list layout whitespace cleanup (#2159) 2025-01-08 12:18:17 -05:00
Patrice Chalin 3aa3dc741f
Blog list layout: display the page title and content (#2157) 2025-01-08 11:49:09 -05:00
Patrice Chalin 6c22754f04
Blog list layout refactoring (#2155) 2025-01-07 17:04:11 -05:00
Patrice Chalin 95a08e118b
[CI] Upgrade NPM pkgs, Hugo to 0.140.2 (#2154) 2025-01-07 12:49:26 -05:00
rinsuki 2f361b2b6c
i18n: Add feedback_* to i18n/ja.toml (#2149) 2025-01-04 12:09:10 -05:00
Andreas Deininger fa81a86be8
Bump dependency Font-Awesome to latest version 6.7.2 (#2151) 2025-01-03 16:59:17 -05:00
Patrice Chalin 67f6b6a504
Blog 2024 review: Add link to LFX mentorships (#2147) 2024-12-12 13:27:01 -05:00
Patrice Chalin f3e6ca948b
Blog 2024 year in review (#2145) 2024-12-12 12:41:08 -05:00
Patrice Chalin 99c2842680
[CI] Upgrade NPM pkgs, Hugo to 0.139.4 (#2143) 2024-12-12 10:05:14 -05:00
Patrice Chalin dd72a276e6
[CI] Patch search page HTML until Hugo is fixed, FA upgrade (#2135) 2024-11-23 06:34:07 -05:00
Patrice Chalin fed2d28d24
Upgrade Hugo and FontAwesome (#2129) 2024-11-20 06:09:53 -05:00
Patrice Chalin 97dadaa6f4
[CI] Handle creation of empty Hugo-modules for deps (#2128) 2024-11-19 18:48:09 -05:00
Patrice Chalin 2a6ecfc3f9
Update CHANGELOG.md: fix copy-paste error (#2127) 2024-11-19 17:33:23 -05:00
Shihyu 706e23cbc0
Fix typo in deployment documentation (#2123) 2024-11-16 10:29:23 -05:00
Patrice Chalin aedef51e9c
Upgrade Hugo and merge optional deps into dev (#2125) 2024-11-15 11:47:52 -05:00
Patrice Chalin d1e6470a1d
[CI] Restore format check as a part of `npm test` (#2124) 2024-11-15 11:29:18 -05:00
Patrice Chalin 6e42d49c5d
External link checking + project pages (#2120) 2024-11-15 11:19:51 -05:00
Patrice Chalin 55e0ce291e
[UG] Give guidance on what to do on "failed to load modules" error (#2117) 2024-11-06 10:40:30 -05:00
Andreas Deininger 399457bbf8
User guide: correct instructions on how to disable RSS feed (#2104) 2024-11-06 10:35:47 -05:00
Patrice Chalin a914b38ccd
[CI] Make build checks pass again, skip .md link checking (#2118) 2024-11-06 10:16:29 -05:00
Patrice Chalin 675cff1e40
Delete .s3deploy.yml (#2111) 2024-11-06 09:45:12 -05:00
Patrice Chalin 03333182c9
[UG] NPM install: add `npm init` and switch to YAML config (#2114) 2024-11-06 08:45:19 -05:00
Patrice Chalin a9ee9f44a9
Update pkgs, with Hugo to 0.137.0 (#2112) 2024-11-05 20:17:36 -05:00
Patrice Chalin 768c63fc69
Set NPM package version to next unreleased dev version (#2109) 2024-11-05 19:51:45 -05:00
Alex Boten 68aa7b39fc
Add missing feedback section in french (#2105) 2024-10-31 07:15:59 -04:00
Patrice Chalin 0884d8f936
Update packages: Hugo to 0.136.5 (#2106) 2024-10-30 12:48:42 -04:00
173 changed files with 5673 additions and 1285 deletions

View File

@ -1,4 +1,4 @@
blank_issues_enabled: false
blank_issues_enabled: true
contact_links:
- name: SUPPORT, ISSUES, and TROUBLESHOOTING
url: https://github.com/google/docsy/discussions

View File

@ -1,19 +0,0 @@
{
"ignorePatterns": [
{
"pattern": "^http://localhost"
},
{
"pattern": "^https://badges.netlify.com/api/docsydocs.svg\\?branch=main"
},
{
"pattern": "^https://docs.npmjs.com/cli/v10/using-npm/scripts#prepare-and-prepublish"
},
{
"pattern": "^#070$"
}
],
"timeout": "3s",
"retryOn429": true,
"aliveStatusCodes": [200, 206]
}

View File

@ -1,6 +0,0 @@
.editorconfig
.gitattributes
.gitignore
.nvmrc
.prettierignore
.s3deploy.yml

View File

@ -1,14 +0,0 @@
routes:
- route: "^.+\\.(js|css|svg|ttf)$"
# cache static assets for 20 years
headers:
Cache-Control: "max-age=630720000, no-transform, public"
gzip: true
- route: "^.+\\.(png|jpg)$"
headers:
Cache-Control: "max-age=630720000, no-transform, public"
gzip: true
- route: "^.+\\.(html|xml|json)$"
gzip: true

3
.vscode/cspell.json vendored
View File

@ -4,7 +4,10 @@
"caseSensitive": true,
"words": [
"Docsy",
"errorf",
"hugo",
"relref",
"scrollspy",
"shortcode",
"shortcodes",
"tabpane",

View File

@ -18,20 +18,97 @@ Useful links:
[releases]: https://github.com/google/docsy/releases
[tags]: https://github.com/google/docsy/tags
## 0.11.1 or 0.12.0
## 0.12.1 or 0.13.0
> ### UNRELEASED: this planned version is still under development
> **UNRELEASED: this planned version is still under development**
For the full list of changes, see the [0.x.y] release notes.
**Breaking changes**:
- **Shortcodes**:
- The alert shortcode has been reworked to address [#906] and [#939]. It can
now be used with Markdown content, and it can contain calls to other
shortcodes. For details, see [Shortcode helpers > alert][] ([#941])
- ...
[#941]: https://github.com/google/docsy/pull/941
[Shortcode helpers > alert]:
https://www.docsy.dev/docs/adding-content/shortcodes/#alert
**New**:
**Other changes**:
[0.x.y]: https://github.com/google/docsy/releases/latest?FIXME=v0.X.Y
## 0.12.0
For the full list of changes, see the [0.12.0] release notes.
**Breaking changes**:
- Renames the default Docsy heading render hook and heading self-link partials.
This is a breaking change only if your project uses this feature. For details,
see [Heading self links][] ([#2223]).
- Relocates and adapts layouts in response to Hugo's [new template system][].
For details, see [Adapt to new template system in Hugo v0.146.0 #2243][#2243].
- **IMPORTANT**: if your project overrides any of the layout files mentioned in
[#2243], then apply the same name changes in your project files. In
particular, note that:
- Taxonomy-related layout files: names have been _swapped_, and `terms.html`
is now singular ([#2257]):
- Renames `_default/taxonomy.html` to `term.html` (singular)
- Renames `_default/terms.html` to `taxonomy.html`
- Renames `layouts/**/content.html` by adding a `_td-` filename prefix
([#2259]).
[#2257]: https://github.com/google/docsy/pull/2257
[#2259]: https://github.com/google/docsy/pull/2259
[new template system]: https://gohugo.io/templates/new-templatesystem-overview/
**Potential breaking changes**:
- Removes shortcode `figure`, hugo's built-in shortcode `figure` can/will be
used instead.
**New**:
- **[Breadcrumb navigation]** support has been enhanced and adjusted:
- You can now disable breadcrumbs for an entire project, or individual pages
or sections by setting `ui.breadcrumb_disable` to true. For details, see
[Breadcrumb navigation][].
- **Blog** pages now also have breadcrumbs by default ([#1788]).
- Index-page single-element breadcrumb lists are hidden by default ([#2160]).
- Support for a [_td-content-after-header.html] page-content render hook, which
can be [content type][] specific ([#2192]). For details, see the [User
Guide][before-page-content].
**Other changes**:
- **Blog** section index page content and title used to be ignored, they are now
displayed ([#1787]). To recover the old behavior use the following style
override: `.td-section.td-blog .td-content { display: none; }`.
- Adds a `comment` shortcode, as a drop-in replacement for the one removed from
Hugo.
[0.12.0]: https://github.com/google/docsy/releases/v0.12.0
[#1787]: https://github.com/google/docsy/issues/1787
[#1788]: https://github.com/google/docsy/issues/1788
[#2160]: https://github.com/google/docsy/pull/2160
[#2192]: https://github.com/google/docsy/pull/2192
[#2223]: https://github.com/google/docsy/pull/2223
[#2243]: https://github.com/google/docsy/pull/2243
[before-page-content]:
https://www.docsy.dev/docs/adding-content/lookandfeel/#before-page-content
[Breadcrumb navigation]:
https://www.docsy.dev/docs/adding-content/navigation/#breadcrumb-navigation
[content type]: https://gohugo.io/quick-reference/glossary/#content-type
[Heading self links]:
https://www.docsy.dev/docs/adding-content/navigation/#heading-self-links
[_td-content-after-header.html]:
https://github.com/google/docsy/blob/main/layouts/_td-content-after-header.html
## 0.11.0
For the full list of changes, see the [0.11.0] release notes.
@ -45,7 +122,7 @@ For the full list of changes, see the [0.11.0] release notes.
- When a section's sidebar entries are truncated because there are more than
[params.ui.sidebar_menu_truncate] section entries, a warning is issued.
[0.11.0]: https://github.com/google/docsy/releases/latest?FIXME=v0.X.Y
[0.11.0]: https://github.com/google/docsy/releases/v0.11.0
[bs-rtl]: https://getbootstrap.com/docs/5.3/getting-started/rtl/
[Adding a community page]:
https://www.docsy.dev/docs/adding-content/content/#adding-a-community-page
@ -106,11 +183,12 @@ this release are listed next.
[path_base_for_github_subdir]. Projects will need to adjust the value of
[path_base_for_github_subdir] to be relative to the file's physical location.
- Class names to disable [repository links] were misnamed with a suffix of the form
`--KIND`. The new suffix is `__KIND`. For details, see [Disabling links].
- Class names to disable [repository links] were misnamed with a suffix of the
form `--KIND`. The new suffix is `__KIND`. For details, see [Disabling links].
- **Heading self-link** support has been reimplemented and projects must now
explicitly enable the feature. For details, see [Heading self links].
explicitly enable the feature. For details, see [Heading self
links][0.9.0:hsl].
**Footer changes**: refactoring, for easier customization, and simplification.
For details concerning all footer changes, see [#1818].
@ -138,7 +216,7 @@ For details concerning all footer changes, see [#1818].
[Footer layout]: https://www.docsy.dev/blog/2024/0.9.0/#footer-layout
[Footer copyright]: https://www.docsy.dev/blog/2024/0.9.0/#footer-copyright
[Footer streamlined]: https://www.docsy.dev/blog/2024/0.9.0/#footer-streamlined
[Heading self links]: https://www.docsy.dev/blog/2024/0.9.0/#heading-self-links
[0.9.0:hsl]: https://www.docsy.dev/blog/2024/0.9.0/#heading-self-links
[look and feel]: https://www.docsy.dev/blog/2024/0.9.0/#look-and-feel
[mermaid]:
https://www.docsy.dev/docs/adding-content/diagrams-and-formulae/#diagrams-with-mermaid
@ -155,10 +233,11 @@ For the full list of changes, see the [0.8.0] release notes.
**Breaking changes**:
- Docsy is packaged as a **single Hugo module** ([#1120]).
- For details, see [Use Docsy as a Hugo Module].
- **Important**: non-Hugo-module projects should read the [Docsy NPM install
side-effect] note.
- Docsy is packaged as a **single Hugo module** ([#1120]). For details, see [Use
Docsy as a Hugo Module].
- **Important**: non-Hugo-module projects should be aware of the [Docsy NPM
install side-effect]. Also, for guidance on Hugo-reported "failed to load
modules" error, see [Docsy as an NPM package].
- **Page feedback**, or [User feedback]:
- In support of projects configuring analytics outside of Docsy, feedback
functionality is enabled regardless of whether
@ -177,6 +256,8 @@ For the full list of changes, see the [0.8.0] release notes.
[#1726]: https://github.com/google/docsy/pull/1726
[#1727]: https://github.com/google/docsy/pull/1727
[0.8.0]: https://github.com/google/docsy/releases/v0.8.0
[Docsy as an NPM package]:
https://docsy.dev/docs/get-started/other-options/#option-3-docsy-as-an-npm-package
[Docsy NPM install side-effect]:
https://docsy.dev/docs/get-started/other-options/#docsy-npm-install-side-effect
[Use Docsy as a Hugo Module]:
@ -252,7 +333,8 @@ For the full list of changes, see the [0.7.0] release notes.
- **Shortcodes**:
- Now using Hugo's native support for processing HTML & markdown, not file
extension testing. ([#906])
- Dropped support for pre-Hugo-0.54.x behavior of `{{% %}}`. ([#939])
- Dropped support for pre-Hugo-0.54.x behavior of [shortcodes with markdown],
`{{%/*...*/%}}`. ([#939])
- `blocks/section`: **default** and accepted values of the `type` argument
have changed! For details, see [blocks/section] ([#1472]).
- **Card shortcodes** ([#1376])]:
@ -265,6 +347,8 @@ For the full list of changes, see the [0.7.0] release notes.
[chroma-docsy]:
https://www.docsy.dev/docs/adding-content/lookandfeel/#code-highlighting-with-chroma
[shortcodes with markdown]:
https://gohugo.io/content-management/shortcodes/#shortcodes-with-markdown
- **Detection of draw.io diagrams** is now **disabled** by default [#1185]
@ -336,12 +420,13 @@ CHANGES** are documented below.
as text.
- **Display logo by default**. Most projects show their logo in the navbar. In
support of this majority, Docsy now displays a logo by default. For details on
how to hide the logo (or your brand name), see [Styling your project logo and name].
how to hide the logo (or your brand name), see [Styling your project logo and
name].
- **Upgraded Bootstrap** to v4.6.2 from v4.6.1, resulting in some style changes
(such as an adjustment in the size of `small`). For details, see [v4.6.2
release notes].
- **[Upgraded FontAwesome]** to v6 from v5. While many icons were renamed, the v5
names still work. For details about icon renames and more, see [What's
- **[Upgraded FontAwesome]** to v6 from v5. While many icons were renamed, the
v5 names still work. For details about icon renames and more, see [What's
changed].
- **Search-box**: the HTML structure and class names have changed, due to the
Font Awesome upgrade, for both online and offline search. This may affect your
@ -449,9 +534,10 @@ For the full list of changes, see the [0.2.0] release notes.
**New**:
- Add official Docsy support for [Hugo modules]. Many thanks to the dedicated and
patient efforts of [@deining], who researched, experimented, and implemented this
feature. Thanks to [@deining] and [@LisaFC] for the doc updates.
- Add official Docsy support for [Hugo modules]. Many thanks to the dedicated
and patient efforts of [@deining], who researched, experimented, and
implemented this feature. Thanks to [@deining] and [@LisaFC] for the doc
updates.
For details, see
[Migrate to Hugo Modules](https://www.docsy.dev/docs/updating/convert-site-to-module/).
@ -463,9 +549,10 @@ For the full list of changes, see the [0.2.0] release notes.
<!-- ENTRY TEMPLATE ------------------------------------------------------
```
## 0.X.Y
> ### UNRELEASED: this planned version is still under development
> **UNRELEASED: this planned version is still under development**
For the full list of changes, see the [0.x.y] release notes.
@ -478,5 +565,6 @@ For the full list of changes, see the [0.x.y] release notes.
**Other changes**:
[0.x.y]: https://github.com/google/docsy/releases/latest?FIXME=v0.X.Y
```
---------------------------------------------------------------------------->

View File

@ -51,9 +51,9 @@ repo.
the end of the file. (Note that change details are autogenerated by GitHub
in a later step.)
3. **Update Docsy version** to v0.X.Y for:
- `version` key in [package.json](package.json)
- `version` key in [userguide/hugo.yaml][]
4. Run `npm run ci:prepare` to ensure that vendor assets and [go.mod](go.mod)
- `version` key in [package.json]
- `version` key in [userguide/hugo.yaml]
4. Run `npm run ci:prepare` to ensure that vendor assets and [go.mod]
dependencies are up-to-date.
5. **Submit a PR with your changes**, using a title like "Release v0.X.Y
preparation".
@ -117,19 +117,22 @@ Assuming that Docsy release v0.X.Y has been successfully deployed and use by at
least one downstream project, then perform the following actions before any
further changes are merged into the default branch:
1. Set `version` in [package.json](package.json) to the next planned (or the
next dot) release with a dev suffix, such as `v0.X.Z-dev.0-unreleased`.
1. Set `version` in [package.json] to the next planned (or the next dot) release
with a dev suffix, such as `v0.X.Z-dev-unreleased`.
2. In the [CHANGELOG]:
- **Create a new entry** for the next release by copying the ENTRY TEMPLATE
at the end of the file.
- **Pin the 0.X.Y release URL**, which ends with `latest?FIXME=...`, to the
v0.X.Y release at `https://github.com/google/docsy/releases/v0.x.y`.
3. **Submit a PR with your changes**, using a title like "Set NPM package
version to next unreleased dev vers".
version to next unreleased dev version".
4. **Get PR approved and merged**.
[CHANGELOG]: CHANGELOG.md
[CHANGELOG]: https://github.com/google/docsy/blob/main/CHANGELOG.md
[contribution guidelines]: https://www.docsy.dev/docs/contribution-guidelines/
[docsy-example]: https://github.com/google/docsy-example
[Draft a new release]: https://github.com/google/docsy/releases/new
[userguide/hugo.yaml]: userguide/hugo.yaml
[go.mod]: https://github.com/google/docsy/blob/main/go.mod
[package.json]: https://github.com/google/docsy/blob/main/package.json
[userguide/hugo.yaml]:
https://github.com/google/docsy/blob/main/userguide/hugo.yaml

View File

@ -1,12 +1,7 @@
# Docsy
[![Project status: active The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Project releases](https://img.shields.io/github/release/google/docsy)](https://github.com/google/docsy/releases)
[![Project build Status](https://badges.netlify.com/api/docsydocs.svg?branch=main)](https://app.netlify.com/sites/docsydocs/deploys)
[![Project contributors](https://img.shields.io/github/contributors/google/docsy)](https://github.com/google/docsy/graphs/contributors)
[![Project license](https://img.shields.io/github/license/google/docsy)](https://github.com/google/docsy/blob/main/LICENSE)
## 🚧 WARNING 🚧 : `main` is under development and potentially unstable! Use official Docsy [releases].
> **🚧 WARNING 🚧 : `main` is under development and potentially unstable! Use
> official Docsy [releases].**
Docsy is a [Hugo](https://gohugo.io) theme for technical documentation sets,
providing simple navigation, site structure, and more.
@ -95,8 +90,8 @@ requests, see [CONTRIBUTING.md]. Thank you to all past, present, and future
## License
This project is licensed under the Apache License 2.0 - see the
[LICENSE.md](https://github.com/google/docsy/blob/main/LICENSE) file for details
This project is licensed under the Apache License 2.0 - see
[LICENSE](https://github.com/google/docsy/blob/main/LICENSE) for details
[code of conduct]:
https://github.com/google/.github/blob/master/CODE_OF_CONDUCT.md

View File

@ -5,12 +5,16 @@
color: inherit;
border-radius: 0;
:last-child {
margin-bottom: 0;
}
.alert-heading {
color: var(--bs-alert-link-color);
}
@each $color, $value in $theme-colors {
&-#{$color} {
& .alert-heading {
color: $value;
}
border-style: solid;
border-color: $value;
border-width: 0 0 0 4px;

View File

@ -2,7 +2,11 @@
.td-breadcrumbs {
@media print {
display: none !important;
display: none;
}
&__single {
display: none;
}
.breadcrumb {

View File

@ -8,7 +8,7 @@
p,
li,
td {
font-weight: $font-weight-body-text;
font-weight: $td-font-weight-body-text;
}
> h1 {
@ -96,7 +96,7 @@
}
.td-heading-self-link {
&:before {
&::before {
content: '#';
}

View File

@ -23,7 +23,7 @@ div.drawioframe {
height: 100%;
width: 100%;
top: 0;
left: 0px;
left: 0;
z-index: 1000;
background: #000b;
border: 0;

View File

@ -1,6 +1,7 @@
//
// Main navbar
//
// cSpell:ignore onscroll
.td-navbar-cover {
@include media-breakpoint-up(md) {
@ -114,7 +115,7 @@
li i {
padding-right: 0.5em;
&:before {
&::before {
display: inline-block;
text-align: center;
min-width: 1em;
@ -127,13 +128,13 @@
border: 0;
font-weight: inherit;
&:before {
&::before {
display: inline-block;
font-style: normal;
font-variant: normal;
text-rendering: auto;
-webkit-font-smoothing: antialiased;
font-family: $font-awesome-font-name;
font-family: $td-font-awesome-font-name;
font-weight: 900;
content: "\f0d9";
padding-left: 0.5em;
@ -182,13 +183,13 @@ nav.foldable-nav {
padding-left: 1.5em;
}
.ul-1 .with-child > label:before {
.ul-1 .with-child > label::before {
display: inline-block;
font-style: normal;
font-variant: normal;
text-rendering: auto;
-webkit-font-smoothing: antialiased;
font-family: $font-awesome-font-name;
font-family: $td-font-awesome-font-name;
font-weight: 900;
content: "\f0da";
position: absolute;
@ -203,7 +204,7 @@ nav.foldable-nav {
}
}
.ul-1 .with-child > input:checked ~ label:before {
.ul-1 .with-child > input:checked ~ label::before {
color: var(--bs-secondary-color);
transform: rotate(90deg);
transition: transform 0.5s;
@ -216,12 +217,12 @@ nav.foldable-nav {
@media (hover: hover) and (pointer: fine) {
nav.foldable-nav {
.ul-1 .with-child > label:hover:before {
.ul-1 .with-child > label:hover::before {
color: var(--bs-link-color);
transition: color 0.3s;
}
.ul-1 .with-child > input:checked ~ label:hover:before {
.ul-1 .with-child > input:checked ~ label:hover::before {
color: var(--bs-link-color);
transition: color 0.3s;
}

View File

@ -19,7 +19,7 @@
// Click-through to the underlying input.
pointer-events: none;
&:before {
&::before {
@extend .fa;
content: fa-content($fa-var-search);
}
@ -67,7 +67,7 @@
}
.td-search-input {
text-indent: 0px;
text-indent: 0;
}
}
@ -114,7 +114,7 @@
// cursor: pointer;
float: right;
&:after {
&::after {
@extend .fas;
content: fa-content($fa-var-times);
}

View File

@ -25,6 +25,11 @@
}
.td-toc {
$toc-padding-base: 1rem;
$toc-padding-increment: 0.5rem; // for TOC entry nesting
margin-top: 1rem;
a {
display: block;
font-weight: $font-weight-light;
@ -36,23 +41,49 @@
display: block;
}
li li {
margin-left: 0.5rem;
> .toc-title {
font-weight: $font-weight-bold;
color: var(--bs-secondary-color);
border-bottom: 1px solid var(--bs-tertiary-color);
padding-bottom: 0.5rem;
margin-bottom: 0.5rem;
}
#TableOfContents {
// Hugo's ToC is a mouthful, this can be used to style the top level h2 entries.
> ul > li > ul > li > a {
}
margin-left: -0.75rem;
a {
margin-left: 0;
padding-left: $toc-padding-base;
text-decoration: none;
border-left: .125rem solid transparent;
transition: color 0.15s ease-in-out, border-color 0.15s ease-in-out;
color: var(--bs-secondary-color);
&.active {
color: var(--bs-primary);
border-left-color: var(--bs-primary);
background-color: var(--bs-secondary-bg-subtle);
}
&:focus,
&:hover {
color: initial;
}
}
ul ul a {
padding-left: $toc-padding-base + $toc-padding-increment;
}
ul ul ul a {
padding-left: $toc-padding-base + ($toc-padding-increment * 2);
}
ul ul ul ul a {
padding-left: $toc-padding-base + ($toc-padding-increment * 3);
}
ul ul ul ul ul a {
padding-left: $toc-padding-base + ($toc-padding-increment * 4);
}
}
ul {

View File

@ -39,7 +39,8 @@
list-style: none;
}
&.ul-0, ul {
&.ul-0,
ul {
padding: 0;
margin: 0;
}
@ -87,14 +88,9 @@
}
}
.dropdown {
a {
color: var(--bs-tertiary-color);
}
.nav-link {
padding: 0 0 1rem;
}
.dropdown .nav-link {
padding-left: 1.5rem;
margin-bottom: 0.5rem;
}
& > .td-sidebar-nav__section {
@ -104,7 +100,7 @@
li i {
// Layout of icons
padding-right: 0.5em;
&:before {
&::before {
display: inline-block;
text-align: center;
min-width: 1em;
@ -123,7 +119,6 @@
@include media-breakpoint-up(md) {
padding-top: 4rem;
background-color: var(--bs-body-tertiary-bg);
padding-right: 1rem;
border-right: 1px solid var(--bs-border-color);
}

View File

@ -24,7 +24,7 @@
display: inline-block;
width: 100%;
font-size: 1rem;
font-weight: 700;
font-weight: $font-weight-bold;
color: var(--bs-primary-text-emphasis);
border-bottom: 1px solid var(--bs-tertiary-color);
margin-bottom: 1em;
@ -203,7 +203,7 @@
font-variant: normal;
text-rendering: auto;
-webkit-font-smoothing: antialiased;
font-family: $font-awesome-font-name;
font-family: $td-font-awesome-font-name;
// font-weight: 900;
padding-right: 0.5em;
font-size: 2em;
@ -288,24 +288,24 @@
margin-bottom: 1.5rem;
}
.article-teaser.article-type-docs h3 a:before {
.article-teaser.article-type-docs h3 a::before {
display: inline-block;
font-style: normal;
font-variant: normal;
text-rendering: auto;
-webkit-font-smoothing: antialiased;
font-family: $font-awesome-font-name;
font-family: $td-font-awesome-font-name;
content: "\f02d";
padding-right: 0.5em;
}
.article-teaser.article-type-blog h3 a:before {
.article-teaser.article-type-blog h3 a::before {
display: inline-block;
font-style: normal;
font-variant: normal;
text-rendering: auto;
-webkit-font-smoothing: antialiased;
font-family: $font-awesome-font-name;
font-family: $td-font-awesome-font-name;
content: "\f781";
padding-right: 0.5em;
}
@ -315,13 +315,13 @@
line-height: 1.2;
font-size: 1.5rem;
&:before {
&::before {
display: inline-block;
font-style: normal;
font-variant: normal;
text-rendering: auto;
-webkit-font-smoothing: antialiased;
font-family: $font-awesome-font-name;
font-family: $td-font-awesome-font-name;
content: "\f122";
padding-right: 0.5em;
}
@ -334,11 +334,11 @@
}
.breadcrumb {
margin-bottom: 0em;
margin-bottom: 0;
font-size: 0.85rem;
}
.article-meta {
margin-bottom: 0em;
margin-bottom: 0;
}
}

View File

@ -3,22 +3,6 @@
$enable-gradients: true !default;
$enable-shadows: true !default;
// Theme colors
// TODO: consider moving all of these theme-color definitions into the User
// Guide SCSS, or declare theme here, but namespaced:
$primary: #30638e !default;
$secondary: #ffa630 !default;
$success: #3772ff !default;
$info: #c0e0de !default;
$warning: #ed6a5a !default;
$danger: #ed6a5a !default;
$light: #d3f3ee !default; // TODO: consider using BS value
$dark: #403f4c !default; // TODO: consider using BS value
$code-color: shade-color($secondary, 40%) !default;
:root,
[data-bs-theme="light"] {
--td-pre-bg: var(--bs-tertiary-bg);
@ -34,54 +18,27 @@ $code-color: shade-color($secondary, 40%) !default;
$td-box-colors: $dark, $primary, $secondary, $info, $white, $gray-600, $success,
$warning, $dark, $danger, $primary, $secondary, $info !default;
$link-color: $blue-500 !default;
$link-shade-percentage: 30% !default;
// Fonts
$td-enable-google-fonts: true !default;
$td-enable-google-fonts: false !default;
$google_font_name: "Open Sans" !default;
$google_font_family: "Open+Sans:300,300i,400,400i,700,700i" !default;
$web-font-path: "https://fonts.googleapis.com/css?family=#{$google_font_family}&display=swap";
$font-awesome-font-name: "Font Awesome 6 Free" !default;
$td-fonts-serif: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto,
"Helvetica Neue", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji",
"Segoe UI Symbol";
$td-font-awesome-font-name: "Font Awesome 6 Free" !default;
$td-google-font-name: "Open Sans" !default;
$td-google-font-family: "Open+Sans:300,300i,400,400i,700,700i" !default;
$td-web-font-path: "https://fonts.googleapis.com/css?family=#{$td-google-font-family}&display=swap";
@if $td-enable-google-fonts {
$td-fonts-serif: join("#{$google_font_name}", $td-fonts-serif);
$td-fonts-serif: join("#{$td-google-font-name}", $td-fonts-serif);
}
$font-family-sans-serif: $td-fonts-serif !default; // TODO: consider moving into UG SCSS or namespace the var (td-)
$font-family-sans-serif: null !default;
@if $td-enable-google-fonts {
$font-family-sans-serif: $td-fonts-serif;
}
$font-family-monospace: SFMono-Regular, Menlo, Monaco, Consolas,
"Liberation Mono", "Courier New", monospace !default; // TODO: consider moving into UG SCSS or namespace the var (td-)
$font-family-base: $font-family-sans-serif !default; // TODO: consider moving into UG SCSS or namespace the var (td-)
// Font weights
$font-weight-medium: 500 !default; // TODO: move into var forward file after upgrading BS to v5.3+
$font-weight-body-text: $font-weight-normal !default;
// Heading sizes
$h3-font-size: $font-size-base * 1.5 !default; // TODO: consider using BS default (* 1.75), or moving into UG SCSS
$h4-font-size: $font-size-base * 1.35 !default; // TODO: consider using BS default (* 1.5), or moving into UG SCSS
$h5-font-size: $font-size-base * 1.15 !default; // TODO: consider using BS default (* 1.25), or moving into UG SCSS
$td-font-weight-body-text: $font-weight-normal !default;
// Space
$td-block-space-top-base: 4 * $spacer !default;
$td-block-space-bottom-base: 4 * $spacer !default;
// Pagination
$pagination-color: $gray-600 !default; // TODO: consider using BS default
$pagination-disabled-color: $gray-300 !default; // TODO: consider using BS default
// Footer
$list-inline-padding: $spacer;

View File

@ -1,21 +1,58 @@
// Forward declarations of variables used by _variables.scss and
// _variables_project.scss.
//
// TODO(@chalin): autogenerate the content of this file
// Docsy theme variables:
//
// Note: since these are Docsy variables, we don't forward (repeat) the
// definitions, we've simply added them here.
$td-fonts-serif: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto,
"Helvetica Neue", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji",
"Segoe UI Symbol" !default;
$td-font-family-monospace: SFMono-Regular, Menlo, Monaco, Consolas,
"Liberation Mono", "Courier New", monospace !default;
// ===================================================
// DO NOT EDIT non-comment lines beyond this point
// since they are auto-refreshed.
// Bootstrap SASS variables:
$white: #fff !default;
$gray-100: #f8f9fa !default;
$gray-200: #e9ecef !default;
$gray-300: #dee2e6 !default;
$gray-400: #ced4da !default;
$gray-500: #adb5bd !default;
$gray-600: #6c757d !default;
$gray-700: #495057 !default;
$gray-800: #343a40 !default;
$gray-900: #212529 !default;
$black: #000 !default;
$blue: #0d6efd !default;
$indigo: #6610f2 !default;
$purple: #6f42c1 !default;
$pink: #d63384 !default;
$red: #dc3545 !default;
$orange: #fd7e14 !default;
$yellow: #ffc107 !default;
$green: #198754 !default;
$teal: #20c997 !default;
$cyan: #0dcaf0 !default;
$blue-500: $blue !default;
$font-size-base: 1rem !default;
$font-weight-normal: 400 !default;
$font-weight-bold: 700 !default;
$font-size-base: 1rem !default; // Assumes the browser default, typically `16px`
$font-weight-normal: 400 !default;
$font-weight-bold: 700 !default;
$spacer: 1rem !default;
$primary: $blue !default;
$secondary: $gray-600 !default;
$success: $green !default;
$info: $cyan !default;
$warning: $yellow !default;
$danger: $red !default;
$light: $gray-100 !default;
$dark: $gray-900 !default;

View File

@ -1,3 +1,5 @@
// cSpell:ignore pageinfo
@import "../vendor/bootstrap/scss/functions";
@import "variables_forward";
@ -8,9 +10,9 @@
@import "../vendor/bootstrap/scss/bootstrap";
@import "support/bootstrap_vers_test";
@import "../vendor/Font-Awesome/scss/fontawesome.scss";
@import "../vendor/Font-Awesome/scss/solid.scss";
@import "../vendor/Font-Awesome/scss/brands.scss";
@import "../vendor/Font-Awesome/scss/fontawesome";
@import "../vendor/Font-Awesome/scss/solid";
@import "../vendor/Font-Awesome/scss/brands";
@import "variables_project_after_bs";
@ -39,7 +41,7 @@
@if $td-enable-google-fonts {
@import url($web-font-path);
@import url($td-web-font-path);
}
.td-footer {
@ -75,7 +77,7 @@
&-item {
@extend .list-inline-item;
@extend .h3;
@include font-size(map-get($font-sizes, 4));
a {
color: inherit !important;
@ -102,10 +104,10 @@
visibility: hidden;
}
h2[id]:before,
h3[id]:before,
h4[id]:before,
h5[id]:before {
h2[id]::before,
h3[id]::before,
h4[id]::before,
h5[id]::before {
display: block;
content: " ";
margin-top: -5rem;

View File

@ -7,7 +7,7 @@
margin-bottom: 0;
a {
font-weight: 700;
font-weight: $font-weight-bold;
}
}

View File

@ -1,2 +1,2 @@
@import "shortcodes/tabbed-pane.scss";
@import "shortcodes/cards-pane.scss";
@import "shortcodes/tabbed-pane";
@import "shortcodes/cards-pane";

View File

@ -24,7 +24,6 @@
pre {
margin: 0;
padding: 0 1rem 1rem 1rem;
}
}
}

View File

@ -10,7 +10,7 @@
border: none;
max-width: 100%;
}
margin-top: 0rem;
margin-top: 0;
margin-bottom: 1.5rem;
border-left: $nav-tabs-border-width solid $nav-tabs-border-color;
border-right: $nav-tabs-border-width solid $nav-tabs-border-color;

View File

@ -25,10 +25,7 @@
&::after {
content: "";
position: absolute;
top: 0;
right: 0;
bottom: 0;
left: 0;
inset: 0;
}
&--dark::after {

View File

@ -1,4 +1,6 @@
/* Chroma style: onedark */
/* Generated using: hugo gen chromastyles --style=onedark */
/* Background */ .bg { color:#abb2bf;background-color:#282c34; }
/* PreWrapper */ .chroma { color:#abb2bf;background-color:#282c34; }
/* Other */ .chroma .x { }
@ -20,25 +22,25 @@
/* KeywordType */ .chroma .kt { color:#e5c07b }
/* Name */ .chroma .n { color:#e06c75 }
/* NameAttribute */ .chroma .na { color:#e06c75 }
/* NameBuiltin */ .chroma .nb { color:#e5c07b }
/* NameBuiltinPseudo */ .chroma .bp { color:#e06c75 }
/* NameClass */ .chroma .nc { color:#e5c07b }
/* NameConstant */ .chroma .no { color:#e06c75 }
/* NameDecorator */ .chroma .nd { color:#61afef }
/* NameEntity */ .chroma .ni { color:#e06c75 }
/* NameException */ .chroma .ne { color:#e06c75 }
/* NameFunction */ .chroma .nf { color:#61afef;font-weight:bold }
/* NameFunctionMagic */ .chroma .fm { color:#56b6c2;font-weight:bold }
/* NameLabel */ .chroma .nl { color:#e06c75 }
/* NameNamespace */ .chroma .nn { color:#e06c75 }
/* NameOther */ .chroma .nx { color:#e06c75 }
/* NameProperty */ .chroma .py { color:#e06c75 }
/* NameTag */ .chroma .nt { color:#e06c75 }
/* NameBuiltin */ .chroma .nb { color:#e5c07b }
/* NameBuiltinPseudo */ .chroma .bp { color:#e5c07b }
/* NameVariable */ .chroma .nv { color:#e06c75 }
/* NameVariableClass */ .chroma .vc { color:#e06c75 }
/* NameVariableGlobal */ .chroma .vg { color:#e06c75 }
/* NameVariableInstance */ .chroma .vi { color:#e06c75 }
/* NameVariableMagic */ .chroma .vm { color:#e06c75 }
/* NameFunction */ .chroma .nf { color:#61afef;font-weight:bold }
/* NameFunctionMagic */ .chroma .fm { color:#56b6c2;font-weight:bold }
/* Literal */ .chroma .l { }
/* LiteralDate */ .chroma .ld { }
/* LiteralString */ .chroma .s { color:#98c379 }

View File

@ -1,4 +1,6 @@
/* Chroma style: tango */
/* Generated using: hugo gen chromastyles --style=tango */
/* Background */ .bg { background-color:#f8f8f8; }
/* PreWrapper */ .chroma { background-color:#f8f8f8; }
/* Other */ .chroma .x { color:#000 }
@ -20,25 +22,25 @@
/* KeywordType */ .chroma .kt { color:#204a87;font-weight:bold }
/* Name */ .chroma .n { color:#000 }
/* NameAttribute */ .chroma .na { color:#c4a000 }
/* NameBuiltin */ .chroma .nb { color:#204a87 }
/* NameBuiltinPseudo */ .chroma .bp { color:#3465a4 }
/* NameClass */ .chroma .nc { color:#000 }
/* NameConstant */ .chroma .no { color:#000 }
/* NameDecorator */ .chroma .nd { color:#5c35cc;font-weight:bold }
/* NameEntity */ .chroma .ni { color:#ce5c00 }
/* NameException */ .chroma .ne { color:#c00;font-weight:bold }
/* NameFunction */ .chroma .nf { color:#000 }
/* NameFunctionMagic */ .chroma .fm { color:#000 }
/* NameLabel */ .chroma .nl { color:#f57900 }
/* NameNamespace */ .chroma .nn { color:#000 }
/* NameOther */ .chroma .nx { color:#000 }
/* NameProperty */ .chroma .py { color:#000 }
/* NameTag */ .chroma .nt { color:#204a87;font-weight:bold }
/* NameBuiltin */ .chroma .nb { color:#204a87 }
/* NameBuiltinPseudo */ .chroma .bp { color:#3465a4 }
/* NameVariable */ .chroma .nv { color:#000 }
/* NameVariableClass */ .chroma .vc { color:#000 }
/* NameVariableGlobal */ .chroma .vg { color:#000 }
/* NameVariableInstance */ .chroma .vi { color:#000 }
/* NameVariableMagic */ .chroma .vm { color:#000 }
/* NameFunction */ .chroma .nf { color:#000 }
/* NameFunctionMagic */ .chroma .fm { color:#000 }
/* Literal */ .chroma .l { color:#000 }
/* LiteralDate */ .chroma .ld { color:#000 }
/* LiteralString */ .chroma .s { color:#4e9a06 }

4
go.mod
View File

@ -5,6 +5,6 @@ go 1.12
// AUTO-GENERATED using `npm run get:hugo-modules`
require (
github.com/FortAwesome/Font-Awesome v0.0.0-20240716171331-37eff7fa00de // indirect
github.com/twbs/bootstrap v5.3.3+incompatible // indirect
github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3 // indirect
github.com/twbs/bootstrap v5.3.6+incompatible // indirect
)

8
go.sum
View File

@ -1,4 +1,4 @@
github.com/FortAwesome/Font-Awesome v0.0.0-20240716171331-37eff7fa00de h1:JvHOfdSqvArF+7cffH9oWU8oLhn6YFYI60Pms8M/6tI=
github.com/FortAwesome/Font-Awesome v0.0.0-20240716171331-37eff7fa00de/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
github.com/twbs/bootstrap v5.3.3+incompatible h1:goFoqinzdHfkeegpFP7pvhbd0g+A3O2hbU3XCjuNrEQ=
github.com/twbs/bootstrap v5.3.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3 h1:/iluJkJiyTAdnqrw3Yi9rH2HNHhrrtCmj8VJe7I6o3w=
github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
github.com/twbs/bootstrap v5.3.6+incompatible h1:efmXVyq839m5QQ0+JBUdQQ1TrmoBqvQ5kRhUueKsH+4=
github.com/twbs/bootstrap v5.3.6+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=

View File

@ -18,7 +18,7 @@ outputFormats:
module:
hugoVersion:
extended: true
min: 0.110.0
min: 0.146.0
mounts:
- source: assets
target: assets

View File

@ -77,3 +77,14 @@ other = "Si vous voulez vous impliquer davantage en contribuant à {{ .Site.Titl
other = "Vous pouvez trouver comment contribuer à {{ .Site.Title }} dans nos"
[community_guideline]
other = "Règles de contribution"
# Feedback
[feedback_title]
other = "Feedback"
[feedback_question]
other = "Cette page est-elle utile?"
[feedback_positive]
other = "Oui"
[feedback_negative]
other = "Non"

View File

@ -77,3 +77,13 @@ other = "If you want to get more involved by contributing to {{ .Site.Title }},
other = "You can find out how to contribute to {{ .Site.Title }} in our"
[community_guideline]
other = "Contribution Guidelines"
# Feedback
[feedback_title]
other = "フィードバック"
[feedback_question]
other = "このページは役に立ちましたか?"
[feedback_positive]
other = "役に立った"
[feedback_negative]
other = "役に立たなかった"

View File

@ -20,10 +20,10 @@ other = "i"
# Footer text
[footer_all_rights_reserved]
other = "Alle retter er reservert"
other = "Alle rettigheter er reservert"
[footer_privacy_policy]
other = "Privacy Policy"
other = "Personvernpolicy"
# Post (blog, articles etc.)
@ -36,42 +36,44 @@ other = "Sist endret"
[post_edit_this]
other = "Endre denne siden"
[post_create_child_page]
other = "Create child page"
other = "Lag underside"
[post_create_issue]
other = "Opprett dokumentasjon sak"
[post_create_project_issue]
other = "Opprett prosjekt sak"
[post_posts_in]
other = "Poster i"
other = "Poster til"
[post_reading_time]
other = "minute read"
[post_less_than_a_minute_read]
other = "less than a minute"
[post_view_this]
other = "Vis kildekoden"
# Print support
[print_printable_section]
other = "This is the multi-page printable view of this section."
other = "Dette er flersidevisningen av denne seksjonen."
[print_click_to_print]
other = "Click here to print"
other = "Klikk her for å skrive ut"
[print_show_regular]
other = "Return to the regular view of this page"
other = "Gå tilbake til vanlig sidevisning"
[print_entire_section]
other = "Print entire section"
other = "Skriv ut hele seksjonen"
# Community
[community_join]
other = "Join the {{ .Site.Title }} community"
other = "Bli med i {{ .Site.Title }} fellesskapet"
[community_introduce]
other = "{{ .Site.Title }} is an open source project that anyone in the community can use, improve, and enjoy. We'd love you to join us! Here's a few ways to find out what's happening and get involved."
other = "{{ .Site.Title }} er et åpen kildekodeprosjekt som alle kan bruke, forbedre og glede seg over. Bli med - her er noen måter du kan holde deg oppdatert på og bidra."
[community_learn]
other = "Learn and Connect"
other = "Lær og få kontakt"
[community_using]
other = "Using or want to use {{ .Site.Title }}? Find out more here:"
other = "Bruker du, eller har du lyst til å bruke {{ .Site.Title }}? Lær mer her:"
[community_develop]
other = "Develop and Contribute"
other = "Bidra og videreutvikle"
[community_contribute]
other = "If you want to get more involved by contributing to {{ .Site.Title }}, join us here:"
other = "Dersom du vil involvere deg mer ved å bidra til {{ .Site.Title }}, bli med oss her:"
[community_how_to]
other = "You can find out how to contribute to {{ .Site.Title }} in our"
other = "Du kan finne ut hvordan du bidrar til {{ .Site.Title }} i vår"
[community_guideline]
other = "Contribution Guidelines"
other = "Retningslinjer for bidrag"

90
i18n/oc.toml Normal file
View File

@ -0,0 +1,90 @@
# UI strings. Buttons and similar.
[ui_pager_prev]
other = "Precedent"
[ui_pager_next]
other = "Seguent"
[ui_read_more]
other = "Ne legir mai"
[ui_search]
other = "Cercar dins lo site…"
# Used in sentences such as "Posted in News"
[ui_in]
other = "Dins"
# Used in sentences such as "All Tags"
[ui_all]
other = "Totas"
# Footer text
[footer_all_rights_reserved]
other = "Tot drech reservat"
[footer_privacy_policy]
other = "Politica de confidencialitat"
# Post (blog, articles etc.)
[post_byline_by]
other = "Per"
[post_created]
other = "Creacion"
[post_last_mod]
other = "Darrièra modificacion"
[post_edit_this]
other = "Modificar aquesta pagina"
[post_view_this]
other = "Veire la pagina font"
[post_create_child_page]
other = "Crear una pagina enfant"
[post_create_issue]
other = "Crear una anomalia de documentacion"
[post_create_project_issue]
other = "Crear una anomalia de projècte"
[post_posts_in]
other = "Publicacions dins"
[post_reading_time]
other = "minutas de lectura"
[post_less_than_a_minute_read]
other = "mens d'una minuta de lectura"
# Print support
[print_printable_section]
other = "Aquò es una vista multipagina imprimibla de la seccion."
[print_click_to_print]
other = "Clicar aquí per imprimir"
[print_show_regular]
other = "Tornar a la vista normala d'aquesta pagina"
[print_entire_section]
other = "Imprimir la seccion complèta"
# Community
[community_join]
other = "Rejónher la comunitat {{ .Site.Title }}"
[community_introduce]
other = "{{ .Site.Title }} es un projècte liure que totòm dins la comunitat pòt utilizar, melhorar e n'aprofichar. Nos agradariá que nos rejonguèssetz! Vaquí d'unas etapas per saber çò que se passa e s'implicar."
[community_learn]
other = "Aprendre e se connectar"
[community_using]
other = "Utilizatz o volètz utilizar {{ .Site.Title }}? Aprenètz-ne mai aquí:"
[community_develop]
other = "Desvelopar e contribuir"
[community_contribute]
other = "Se volètz vos implicar en contribuissent a {{ .Site.Title }}, retrobatz-nos:"
[community_how_to]
other = "Podètz trobar cossí contribuir a {{ .Site.Title }} dins nòstra"
[community_guideline]
other = "Guida de contribucion"
# Feedback
[feedback_title]
other = "Feedback"
[feedback_question]
other = "Èra utila aquesta pagina?"
[feedback_positive]
other = "Oc"
[feedback_negative]
other = "Non"

View File

@ -1,5 +1,3 @@
# UI strings. Buttons and similar.
[ui_pager_prev]
@ -18,6 +16,10 @@ other = "Buscar no site…"
[ui_in]
other = "em"
# Used in sentences such as "All Tags"
[ui_all]
other = "todos"
# Footer text
[footer_all_rights_reserved]
other = "Todos os direitos reservados"
@ -25,7 +27,6 @@ other = "Todos os direitos reservados"
[footer_privacy_policy]
other = "Política de Privacidade"
# Post (blog, articles etc.)
[post_byline_by]
other = "Por"
@ -35,6 +36,8 @@ other = "Criado"
other = "Última modificação"
[post_edit_this]
other = "Editar essa página"
[post_view_this]
other = "Ver origem da página"
[post_create_child_page]
other = "Criar uma subpágina"
[post_create_issue]
@ -75,3 +78,13 @@ other = "If you want to get more involved by contributing to {{ .Site.Title }},
other = "You can find out how to contribute to {{ .Site.Title }} in our"
[community_guideline]
other = "Contribution Guidelines"
# Feedback
[feedback_title]
other = "Feedback"
[feedback_question]
other = "Esta página foi útil?"
[feedback_positive]
other = "Sim"
[feedback_negative]
other = "Não"

View File

@ -7,7 +7,7 @@ other = "Попередня"
other = "Наступна"
[ui_read_more]
other = "Детальніше"
other = "Читати далі"
[ui_search]
other = "Пошук по сайту…"
@ -18,64 +18,73 @@ other = "у"
# Used in sentences such as "All Tags"
[ui_all]
other = "все"
other = "всі"
# Footer text
[footer_all_rights_reserved]
other = "Усі права захищені"
other = "Усі права захищено"
[footer_privacy_policy]
other = "Політика конфіденційності"
# Post (blog, articles etc.)
[post_byline_by]
other = "Автор"
[post_created]
other = "Створено"
[post_last_mod]
other = "Змінено"
other = "Востаннє змінено"
[post_edit_this]
other = "Відредагувати сторінку"
other = "Редагувати цю сторінку"
[post_view_this]
other = "Переглянути джерело сторінки"
[post_create_child_page]
other = "Створити додаткову сторінку"
other = "Створити дочірню сторінку"
[post_create_issue]
other = "Запропонувати змінення документації"
other = "Створити запит щодо документації"
[post_create_project_issue]
other = "Запропонувати допрацювання по проекту"
other = "Створити запит щодо проєкту"
[post_posts_in]
other = "Публікації у"
other = "Публікації в"
[post_reading_time]
other = "хвилина читання"
other = "хв. читання"
[post_less_than_a_minute_read]
other = "менше хвилини"
# Print support
[print_printable_section]
other = "Це багатосторінковий друкований вигляд цього розділу."
other = "Це багатосторінкова версія цього розділу для друку."
[print_click_to_print]
other = "Натисність щоб друкувати"
other = "Натисніть тут, щоб надрукувати"
[print_show_regular]
other = "Повернутися до звичайного перегляду сторінки"
[print_entire_section]
other = "Друкувати увесь розділ"
other = "Надрукувати весь розділ"
# Community
[community_join]
other = "Приєднуйтесь до спільноти {{ .Site.Title }}"
[community_introduce]
other = "{{ .Site.Title }} — це проект з відкритим кодом, який будь-хто в спільноті може використовувати, покращувати та насолоджуватися. Ми будемо раді бачити тебе з нами! Ось декілька опцій щоб знати що відбувається та як долучитись."
other = "{{ .Site.Title }} — це проєкт з відкритим вихідним кодом, яким будь-хто зі спільноти може користуватися, покращувати та насолоджуватися. Ми будемо раді, якщо ви приєднаєтеся до нас! Ось кілька способів дізнатися, що відбувається, і взяти участь."
[community_learn]
other = "Вивчай та Приєднуйся"
other = "Вивчайте та приєднуйтесь"
[community_using]
other = "Користуєшся чи хотів би користуватись {{ .Site.Title }}? Дізнайся більше тут:"
other = "Використовуєте або хочете використовувати {{ .Site.Title }}? Дізнайтеся більше тут:"
[community_develop]
other = "Розвивай та Роби внесок"
other = "Розробляйте та робіть внески"
[community_contribute]
other = "Якщо хочеш бути більш залученим, роблячи внесок у {{ .Site.Title }}, приєднуйся до нас тут:"
other = "Хочете долучитися до розвитку {{ .Site.Title }} та зробити свій внесок? Приєднуйтеся до нас тут:"
[community_how_to]
other = "Дізнайся як зробити внесок до цих документів в нашому"
other = "Дізнайтеся, як зробити внесок у {{ .Site.Title }} у наших"
[community_guideline]
other = "Рекомендації щодо внеску"
other = "Настановах з внесків"
# Feedback
[feedback_title]
other = "Зворотний зв’язок"
[feedback_question]
other = "Чи була ця сторінка корисною?"
[feedback_positive]
other = "Так"
[feedback_negative]
other = "Ні"

View File

@ -32,33 +32,33 @@ other = "隱私政策"
[post_byline_by]
other = "作者:"
[post_created]
other = "建"
other = ""
[post_last_mod]
other = "最後修改"
other = "最後更新於"
[post_edit_this]
other = "編輯此頁"
[post_view_this]
other = "查看頁面原始碼"
other = "檢視頁面原始碼"
[post_create_child_page]
other = "建子頁面"
other = "子頁面"
[post_create_issue]
other = "創建文檔議題"
other = "建立文件議題"
[post_create_project_issue]
other = "創建項目議題"
other = "建立專案議題"
[post_posts_in]
other = "張貼於"
[post_reading_time]
other = " 分鐘左右可讀完"
other = " 分鐘閱讀時間"
[post_less_than_a_minute_read]
other = "1 分鐘內可讀完"
# Print support
[print_printable_section]
other = "這是本節的多頁可列印。"
other = "這是本節的多頁可列印視。"
[print_click_to_print]
other = "點此處列印"
other = "點此處列印"
[print_show_regular]
other = "返回此頁面的常規視圖"
other = "返回此頁面的標準檢視"
[print_entire_section]
other = "列印整個章節"
@ -66,16 +66,26 @@ other = "列印整個章節"
[community_join]
other = "加入 {{ .Site.Title }} 社群"
[community_introduce]
other = "{{ .Site.Title }} 是一個開源項目,社群中的任何人都可以使用、改善和盡情使用它。我們很期待你能加入我們!下面是如何查看最近更新以及參與我們的一些方式。"
other = "{{ .Site.Title }} 是一個開放原始碼專案,社群中的任何人都可以使用、改進並享受其成果。我們非常歡迎您加入我們!以下是了解最新動態以及參與我們的一些方式。"
[community_learn]
other = "學習和溝通"
other = "學習與交流"
[community_using]
other = "正在或打算使用 {{ .Site.Title }} ?獲取更多資訊:"
other = "正在或打算使用 {{ .Site.Title }} 嗎?在此取得更多資訊:"
[community_develop]
other = "開發和貢獻"
[community_contribute]
other = "如果你想通過為 {{ .Site.Title }} 貢獻更多參與,請在此處加入我們:"
other = "如果您想透過貢獻來更深入地參與 {{ .Site.Title }},請在此處加入我們:"
[community_how_to]
other = "你可以了解如何為 {{ .Site.Title }} 做出貢獻,請參考我們的"
other = "您可以透過文件了解如何為 {{ .Site.Title }} 做出貢獻,請參考我們的"
[community_guideline]
other = "貢獻指南"
# Feedback
[feedback_title]
other = "意見回饋"
[feedback_question]
other = "這個頁面對您有幫助嗎?"
[feedback_positive]
other = "有幫助"
[feedback_negative]
other = "沒幫助"

View File

@ -1,8 +0,0 @@
<h{{ .Level }} id="{{- .Anchor | safeURL -}}">
{{- .Text | safeHTML -}}
{{ template "_default/_markup/_td-heading-self-link.html" . -}}
</h{{ .Level }}>
{{- define "_default/_markup/_td-heading-self-link.html" -}}
<a class="td-heading-self-link" href="#{{ .Anchor | safeURL }}" aria-label="Heading self-link"></a>
{{- end -}}

View File

@ -1,3 +0,0 @@
{{ define "main" -}}
{{ .Content -}}
{{ end }}

View File

@ -1,30 +0,0 @@
{{/*
This is a copy of https://github.com/gohugoio/hugo/pull/12505,
which changes all `{{- ... }}` to `{{- ... }}. Drop this file if
and once it is merged.
*/ -}}
{{ if not site.Config.Privacy.GoogleAnalytics.Disable }}
{{- with site.Config.Services.GoogleAnalytics.ID }}
{{- if strings.HasPrefix (lower .) "ua-" }}
{{- warnf "Google Analytics 4 (GA4) replaced Google Universal Analytics (UA) effective 1 July 2023. See https://support.google.com/analytics/answer/11583528. Create a GA4 property and data stream, then replace the Google Analytics ID in your site configuration with the new value." }}
{{- else }}
<script async src="https://www.googletagmanager.com/gtag/js?id={{- . }}"></script>
<script>
var doNotTrack = false;
if ({{ site.Config.Privacy.GoogleAnalytics.RespectDoNotTrack }}) {
var dnt = (navigator.doNotTrack || window.doNotTrack || navigator.msDoNotTrack);
var doNotTrack = (dnt == "1" || dnt == "yes");
}
if (!doNotTrack) {
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', '{{ . }}');
}
</script>
{{- end }}
{{- end }}
{{- end -}}

View File

@ -1,3 +1,4 @@
{{/* cSpell:ignore docsearch opengraph outputformat */ -}}
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
{{ range .AlternativeOutputFormats -}}
@ -20,10 +21,10 @@
{{ .Site.Title -}}
{{ end -}}
</title>
<meta name="description" content="{{ template "partials/page-description.html" . }}">
{{ template "_internal/opengraph.html" . -}}
{{ template "_internal/schema.html" . -}}
{{ template "_internal/twitter_cards.html" . -}}
<meta name="description" content="{{ partial "page-description.html" . }}">
{{ partial "opengraph.html" . -}}
{{ partial "schema.html" . -}}
{{ partial "twitter_cards.html" . -}}
{{ partialCached "head-css.html" . "head-css-cache-key" -}}
<script
src="https://code.jquery.com/jquery-3.7.1.min.js"
@ -46,14 +47,14 @@
{{/* To comply with GDPR, cookie consent scripts places in head-end must execute before Google Analytics is enabled */ -}}
{{ if hugo.IsProduction -}}
{{ template "_internal/google_analytics.html" . -}}
{{ partial "google_analytics.html" . -}}
{{ end -}}
{{ define "algolia/head" -}}
{{ if and .Site.Params.search (isset .Site.Params.search "algolia") -}}
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3.6.0"
integrity="sha512-AyDFDkYyALC5qoao077IqAOV7UC4oKCBTp+mJfjIt306AIRoBxoEZYDo0kAx/R7RbT+3EYEky1po/F1w1eQt7g=="
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3.8.2"
integrity="sha512-l7pkV1dOURFyHCeH8I4fK9lCkQKuqhlsTCqRl3zktifDlB8oTUJ+mJPgYkK9kHpUut8j1iPquTv32t6hvTPv3g=="
crossorigin="anonymous" />
{{ end -}}

View File

@ -2,7 +2,7 @@
<div class="td-page-meta__lastmod">
{{ T "post_last_mod" }} {{ .Lastmod.Format .Site.Params.time_format_default -}}
{{ with .GitInfo }}: {{/* Trim WS */ -}}
<a href="{{ $.Site.Params.github_repo }}/commit/{{ .Hash }}">
<a data-proofer-ignore href="{{ $.Site.Params.github_repo }}/commit/{{ .Hash }}">
{{- .Subject }} ({{ .AbbreviatedHash }}) {{- /* Trim WS */ -}}
</a>
{{- end }}

View File

@ -1,6 +1,6 @@
{{ $tpl := printf "print/content-%s.html" .Page.Type }}
{{ if templates.Exists (printf "partials/%s" $tpl) }}
{{ if templates.Exists (printf "_partials/%s" $tpl) }}
{{ partial $tpl . }}
{{ else -}}
{{ $break := cond .DoPageBreak "page-break-before: always" "" -}}

View File

@ -1,7 +1,7 @@
{{/* Use the title and description of the first page to begin the document */}}
{{ $tpl := printf "print/page-heading-%s.html" .Page.Type }}
{{ if templates.Exists (printf "partials/%s" $tpl) }}
{{ if templates.Exists (printf "_partials/%s" $tpl) }}
{{ partial $tpl . }}
{{ else -}}
<h1 class="title">{{ .Title }}</h1>

View File

@ -1,5 +1,5 @@
{{ $tpl := printf "print/toc-li-%s.html" .Page.Type }}
{{ if templates.Exists (printf "partials/%s" $tpl) }}
{{ if templates.Exists (printf "_partials/%s" $tpl) }}
{{ partial $tpl . }}
{{ else -}}
<li>{{ .sid}}: <a href="#pg-{{.Page.File.UniqueID}}">{{ .Page.Title }}</a></li>

View File

@ -1,13 +1,5 @@
{{ $needKaTeX := or .Site.Params.katex.enable .Params.math .Params.chem -}}
{{ $needmhchem := or .Site.Params.katex.mhchem.enable .Params.chem -}}
{{ if ge hugo.Version "0.93.0" -}}
{{ $needKaTeX = or $needKaTeX (.Page.Store.Get "hasKaTeX") (.Page.Store.Get "hasmhchem") -}}
{{ $needmhchem = or $needmhchem (.Page.Store.Get "hasmhchem") -}}
{{ else -}}
{{ if or $needKaTeX $needmhchem -}}
{{ warnf "Outdated Hugo version %s, consider upgrading to make full use of all theme features" hugo.Version }}
{{ end -}}
{{ end -}}
{{ $needKaTeX := or .Params.math .Site.Params.katex.enable .Params.chem .Site.Params.chem (.Page.Store.Get "hasKaTeX") (.Page.Store.Get "hasmhchem") -}}
{{ $needmhchem := or .Params.chem .Site.Params.katex.mhchem.enable (.Page.Store.Get "hasmhchem") -}}
{{ if .Site.Params.markmap.enable -}}
<style>
@ -34,27 +26,8 @@ window.markmap = {
<script src='{{ "js/deflate.js" | relURL }}'></script>
{{ end -}}
{{ if $needKaTeX -}}
{{/* load stylesheet and scripts for KaTeX support */ -}}
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.16.10/dist/katex.min.css"
integrity="sha512-r2+FkHzf1u0+SQbZOoIz2RxWOIWfdEzRuYybGjzKq18jG9zaSfEy9s3+jMqG/zPtRor/q4qaUCYQpmSjTw8M+g==" crossorigin="anonymous">
{{/* The loading of KaTeX is deferred to speed up page rendering */ -}}
<script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.10/dist/katex.min.js"
integrity="sha512-INps9zQ2GUEMCQD7xiZQbGUVnqnzEvlynVy6eqcTcHN4+aQiLo9/uaQqckDpdJ8Zm3M0QBs+Pktg4pz0kEklUg=="
crossorigin="anonymous">
</script>
{{ if $needmhchem -}}
{{/* To add support for displaying chemical equations and physical units, load the mhchem extension: */ -}}
<script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.10/dist/contrib/mhchem.min.js"
integrity="sha512-mxjNw/u1lIsFC09k/unscDRY3ofIYPVFbWkP8slrePcS36ht4d/OZ8rRu5yddB2uiqajhTcLD8+jupOWuYPebg=="
crossorigin="anonymous">
</script>
{{ end -}}
{{/* To automatically render math in text elements, include the auto-render extension: */ -}}
<script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.10/dist/contrib/auto-render.min.js"
integrity="sha512-YJVxTjqttjsU3cSvaTRqsSl0wbRgZUNF+NGGCgto/MUbIvaLdXQzGTCQu4CvyJZbZctgflVB0PXw9LLmTWm5/w==" crossorigin="anonymous"
{{ printf "onload='renderMathInElement(%s, %s);'" (( $.Page.Site.Params.katex.html_dom_element | default "document.body" ) | safeJS ) ( printf "%s" ( $.Page.Site.Params.katex.options | jsonify )) | safeHTMLAttr }}>
</script>
{{ if $needKaTeX -}}
{{ partial "scripts/katex.html" (dict "mhchem" $needmhchem) -}}
{{ end -}}
{{ $jsBs := resources.Get "vendor/bootstrap/dist/js/bootstrap.bundle.js" -}}
@ -104,8 +77,8 @@ window.markmap = {
{{ partial "hooks/body-end.html" . -}}
{{ define "algolia/scripts" -}}
<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@3.6.0"
integrity="sha512-FtDaTWf3IS29TLuYzTPlytjGqcXkwrzG9ivq7xXElnOZeiYTbcIy/hwXAgrrRNnI0+PfN+WFz4/+4phhJmuS8Q=="
<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@3.8.2"
integrity="sha512-lsD+XVzdBI6ZquXc8gqbw0/bgrfIsMJwY/8xvmvbN+U3gZSeG7BXQoCq4zv/yCmntR2GLHtgB+bD4ESPsKIbIA=="
crossorigin="anonymous" ></script>
<script type="text/javascript">
const containers = ['#docsearch-0', '#docsearch-1'];

View File

@ -0,0 +1,55 @@
{{ $version := .Site.Params.katex.version | default "latest" -}}
{{/* load stylesheet and scripts for KaTeX support */ -}}
{{ $katex_css_url := printf "https://cdn.jsdelivr.net/npm/katex@%s/dist/katex%s.css" $version (cond hugo.IsProduction ".min" "") -}}
{{ with try (resources.GetRemote $katex_css_url) -}}
{{ with .Err -}}
{{ errorf "Could not retrieve KaTeX css file from CDN. Reason: %s." . -}}
{{ else with.Value -}}
{{ with resources.Copy (printf "css/katex%s.css" (cond hugo.IsProduction ".min" "")) . }}
{{ $secureCSS := . | resources.Fingerprint "sha512" -}}
<link rel="stylesheet" href="{{- .RelPermalink -}}" integrity="{{- $secureCSS.Data.Integrity -}}" crossorigin="anonymous">
{{ end -}}
{{ end -}}
{{ else -}}
{{ errorf "Invalid KaTeX version %s, could not retrieve this version from CDN." $version -}}
{{ end -}}
{{/* The loading of KaTeX is deferred to speed up page rendering */ -}}
{{ $katex_js_url := printf "https://cdn.jsdelivr.net/npm/katex@%s/dist/katex%s.js" $version (cond hugo.IsProduction ".min" "") -}}
{{ with try (resources.GetRemote $katex_js_url) -}}
{{ with .Err -}}
{{ errorf "Could not retrieve KaTeX script from CDN. Reason: %s." . -}}
{{ else with.Value -}}
{{ with resources.Copy (printf "js/katex%s.js" (cond hugo.IsProduction ".min" "")) . }}
{{ $secureJS := . | resources.Fingerprint "sha512" -}}
<script defer src="{{- .RelPermalink -}}" integrity="{{- $secureJS.Data.Integrity -}}" crossorigin="anonymous" ></script>
{{ end -}}
{{ end -}}
{{ else -}}
{{ errorf "Invalid KaTeX version %s, could not retrieve this version from CDN." $version -}}
{{ end -}}
{{/* Add support for displaying chemical equations and physical units by loading the mhchem extension: */ -}}
{{ if .mhchem -}}
{{ partial "scripts/mhchem.html" (dict "version" $version) -}}
{{ end -}}
{{/* To automatically render math in text elements, include the auto-render extension: */ -}}
{{ $katex_autorender_url := printf "https://cdn.jsdelivr.net/npm/katex@%s/dist/contrib/auto-render%s.js" $version (cond hugo.IsProduction ".min" "") -}}
{{ with try (resources.GetRemote $katex_autorender_url) -}}
{{ with .Err -}}
{{ errorf "Could not retrieve KaTeX auto render extension from CDN. Reason: %s." . -}}
{{ else with .Value -}}
{{ with resources.Copy ( printf "js/auto-render%s.js" (cond hugo.IsProduction ".min" "")) . }}
{{ $secureJS := . | resources.Fingerprint "sha512" -}}
<script defer src="{{- .RelPermalink -}}" integrity="{{- $secureJS.Data.Integrity -}}" crossorigin="anonymous"
{{ printf "onload='renderMathInElement(%s, %s);'" (( $.Page.Site.Params.katex.html_dom_element | default "document.body" ) | safeJS ) ( printf "%s" ( $.Page.Site.Params.katex.options | jsonify )) | safeHTMLAttr -}} >
</script>
{{ end -}}
{{ end -}}
{{ else -}}
{{ errorf "Invalid KaTeX version %s, could not retrieve this version from CDN." $version -}}
{{ end -}}

View File

@ -1,7 +1,7 @@
{{ $version := .Site.Params.mermaid.version | default "latest" -}}
{{ $cdnurl := printf "https://cdn.jsdelivr.net/npm/mermaid@%s/dist/mermaid.esm.min.mjs" $version -}}
{{ with resources.GetRemote $cdnurl -}}
{{ with try (resources.GetRemote $cdnurl) -}}
{{ with .Err -}}
{{ errorf "Could not retrieve mermaid script from CDN. Reason: %s." . -}}
{{ end -}}

View File

@ -0,0 +1,14 @@
{{/* Add support for displaying chemical equations and physical units by loading the mhchem extension: */ -}}
{{ $mhchem_url := printf "https://cdn.jsdelivr.net/npm/katex@%s/dist/contrib/mhchem%s.js" .version (cond hugo.IsProduction ".min" "") -}}
{{ with try (resources.GetRemote $mhchem_url) -}}
{{ with .Err -}}
{{ errorf "Could not retrieve mhchem script from CDN. Reason: %s." . -}}
{{ else with .Value -}}
{{ with resources.Copy (printf "js/mhchem%s.js" (cond hugo.IsProduction ".min" "")) . }}
{{ $secureJS := . | resources.Fingerprint "sha512" -}}
<script defer src="{{- .RelPermalink -}}" integrity="{{- $secureJS.Data.Integrity -}}" crossorigin="anonymous" ></script>
{{ end -}}
{{ end -}}
{{ else -}}
{{ errorf "Invalid KaTeX version %s, could not retrieve this version from CDN." .version -}}
{{ end -}}

View File

@ -0,0 +1,12 @@
<h{{ .Level }}
{{- range $key, $value := .Attributes -}}
{{ printf " %s=%q" $key (string $value) | safeHTMLAttr -}}
{{ end -}}
>
{{- .Text | safeHTML -}}
{{ partial "td/heading-self-link.html" . -}}
</h{{ .Level }}>
{{- define "_partials/td/heading-self-link.html" -}}
<a class="td-heading-self-link" href="#{{ .Anchor | safeURL }}" aria-label="Heading self-link"></a>
{{- end -}}

View File

@ -0,0 +1,10 @@
{{ if not (.Param "ui.scrollspy.disable") -}}
{{ replaceRE `\s+` " "
`
data-bs-spy="scroll"
data-bs-target="#TableOfContents"
data-bs-root-margin="0px 0px -40%"
`
| strings.TrimSpace | add " " -}}
{{ end -}}

View File

@ -2,6 +2,7 @@
{{ with .TableOfContents -}}
{{ if ne . `<nav id="TableOfContents"></nav>` -}}
<div class="td-toc">
<div class="toc-title">On this page</div>
{{ . }}
</div>
{{ end -}}

View File

@ -0,0 +1,30 @@
{{/*
@param {string} [title=""] HTML rendered as a Bootstrap alert heading.
@param {string} [color="primary"] Suffix used for the Bootstrap alert class
`alert-{color}`.
For details, see https://www.docsy.dev/docs/adding-content/shortcodes/#alert.
*/ -}}
{{ $color := .Get "color" | default "primary" -}}
<div class="alert alert-{{ $color }}" role="alert">
{{- with .Get "title" -}}
<div class="h4 alert-heading" role="heading">
{{- . | safeHTML -}}
</div>
{{- end }}
{{/* Do NOT remove the blank line above. It ends the previous HTML block and
ensures that any Markdown in .Inner will be treated as Markdown. For details,
see https://spec.commonmark.org/0.31.2/#html-blocks, 7. */ -}}
{{ .Inner }}
{{- /* Do NOT remove this space trimming comment. It ensures that any Markdown
that _follows_ this shortcode remains correctly indented, in contexts where this
is necessary. */ -}}
</div>

View File

@ -31,7 +31,7 @@
{{ end -}}
{{ with $.Inner -}}
{{ if $code -}}
{{ highlight . $lang $highlight -}}
{{ highlight ( . | strings.TrimSpace ) $lang $highlight -}}
{{ else -}}
<p class="card-text">
{{ . -}}

View File

@ -0,0 +1,8 @@
{{/* Allows for large segments of Markdown or HTML to be commented out. This was
briefly an internal Hugo template, but it is no more. For details, see:
- https://discourse.gohugo.io/t/deprecate-comment-shortcode/53237
- https://github.com/gohugoio/hugo/pull/13294
*/}}
{{- $noop := .Inner -}}

Some files were not shown because too many files have changed in this diff Show More