Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge in upstream changes from mkdocs-material #338

Merged
merged 2 commits into from
Feb 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 1 addition & 5 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2016-2022 Martin Donath <[email protected]>
# Copyright (c) 2016-2025 Martin Donath <[email protected]>

# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
Expand Down Expand Up @@ -30,10 +30,6 @@ end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

# Markdown
[*.md]
trim_trailing_whitespace = false

# Python
[*.py]
indent_style = space
Expand Down
2 changes: 1 addition & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2016-2022 Martin Donath <[email protected]>
# Copyright (c) 2016-2025 Martin Donath <[email protected]>

# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
Expand Down
76 changes: 40 additions & 36 deletions .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
},
"plugins": [
"@typescript-eslint",
"@stylistic/ts",
"eslint-plugin-eslint-comments",
"eslint-plugin-import",
"eslint-plugin-jsdoc",
Expand Down Expand Up @@ -166,7 +167,41 @@
"@typescript-eslint/consistent-type-assertions": "error",
"@typescript-eslint/dot-notation": "error",
"@typescript-eslint/explicit-member-accessibility": "error",
"@typescript-eslint/indent": [
"@typescript-eslint/naming-convention": [
"error",
{
"selector": "enumMember",
"format": [
"UPPER_CASE"
]
}
],
"@typescript-eslint/no-empty-interface": "off",
"@typescript-eslint/no-empty-object-type": "off",
"@typescript-eslint/no-extraneous-class": "error",
"@typescript-eslint/no-misused-promises": "off",
"@typescript-eslint/no-non-null-assertion": "off",
"@typescript-eslint/no-parameter-properties": "off",
"@typescript-eslint/no-floating-promises": "error",
"@typescript-eslint/no-shadow": [
"error",
{
"hoist": "never"
}
],
"@typescript-eslint/no-unnecessary-type-assertion": "error",
"@typescript-eslint/no-unused-expressions": "error",
"@typescript-eslint/no-unused-vars": "off",
"@typescript-eslint/no-var-requires": "off",
"@typescript-eslint/only-throw-error": "error",
"@typescript-eslint/prefer-for-of": "off",
"@typescript-eslint/prefer-function-type": "error",
"@typescript-eslint/triple-slash-reference": "off",
"@typescript-eslint/unbound-method": "error",
"@typescript-eslint/unified-signatures": "error",

/* Plugin: @stylistic/ts */
"@stylistic/ts/indent": [
"warn",
2,
{
Expand All @@ -191,7 +226,7 @@
"offsetTernaryExpressions": true
}
],
"@typescript-eslint/member-delimiter-style": [
"@stylistic/ts/member-delimiter-style": [
"error",
{
"multiline": {
Expand All @@ -203,42 +238,12 @@
}
}
],
"@typescript-eslint/naming-convention": [
"error",
{
"selector": "enumMember",
"format": [
"UPPER_CASE"
]
}
],
"@typescript-eslint/no-empty-interface": "off",
"@typescript-eslint/no-extraneous-class": "error",
"@typescript-eslint/no-misused-promises": "error",
"@typescript-eslint/no-non-null-assertion": "off",
"@typescript-eslint/no-parameter-properties": "off",
"@typescript-eslint/no-floating-promises": "error",
"@typescript-eslint/no-shadow": [
"error",
{
"hoist": "never"
}
],
"@typescript-eslint/no-throw-literal": "error",
"@typescript-eslint/no-unnecessary-type-assertion": "error",
"@typescript-eslint/no-unused-expressions": "error",
"@typescript-eslint/no-unused-vars": "off",
"@typescript-eslint/no-var-requires": "off",
"@typescript-eslint/prefer-for-of": "off",
"@typescript-eslint/prefer-function-type": "error",
"@typescript-eslint/semi": [
"@stylistic/ts/semi": [
"error",
"never"
],
"@typescript-eslint/triple-slash-reference": "off",
"@typescript-eslint/type-annotation-spacing": "error",
"@typescript-eslint/unbound-method": "error",
"@typescript-eslint/unified-signatures": "error",
"@stylistic/ts/type-annotation-spacing": "error",

/* Plugin: eslint-plugin-eslint-comments */
"eslint-comments/no-unused-disable": "error",
"eslint-comments/no-unused-enable": "error",
Expand Down Expand Up @@ -320,7 +325,6 @@
}
],
"jsdoc/empty-tags": "warn",
"jsdoc/newline-after-description": "warn",
"jsdoc/no-bad-blocks": "warn",
"jsdoc/no-defaults": "warn",
"jsdoc/no-types": "warn",
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ jobs:
matrix:
include:
- python-version: "3.x"
node-version: "16.x"
node-version: "20.x"
steps:
- uses: actions/checkout@v4
- name: Setup Node.js
Expand Down Expand Up @@ -78,7 +78,7 @@ jobs:
python-version:
- "3.x"
node-version:
- "16.x"
- '20.x'
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
Expand Down Expand Up @@ -158,7 +158,7 @@ jobs:
- "3.12"
- "3.13"
node-version:
- "16.x"
- '20.x'
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
Expand Down
2 changes: 1 addition & 1 deletion .stylelintignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2016-2022 Martin Donath <[email protected]>
# Copyright (c) 2016-2025 Martin Donath <[email protected]>

# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
Expand Down
54 changes: 29 additions & 25 deletions .stylelintrc
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
{
"extends": [
"stylelint-config-rational-order",
"@stylistic/stylelint-config",
"stylelint-config-recess-order",
"stylelint-config-recommended",
"stylelint-config-standard-scss"
],
"plugins": [
"@stylistic/stylelint-plugin",
"stylelint-scss"
],
"rules": {
Expand Down Expand Up @@ -32,16 +34,6 @@
}
],
"at-rule-no-unknown": null,
"block-closing-brace-newline-after": [
"always",
{
"ignoreAtRules": [
"if",
"else",
"elseif"
]
}
],
"color-function-notation": null,
"color-hex-length": "long",
"color-named": "never",
Expand All @@ -55,26 +47,25 @@
],
"custom-property-empty-line-before": null,
"custom-property-pattern": null,
"declaration-colon-space-after": null,
"declaration-no-important": null,
"declaration-block-single-line-max-declarations": 0,
"font-family-name-quotes": "always-where-recommended",
"font-weight-notation": "numeric",
"function-calc-no-unspaced-operator": null,
"function-no-unknown": null,
"function-url-no-scheme-relative": true,
"function-url-quotes": "always",
"font-family-name-quotes": "always-where-recommended",
"font-weight-notation": "numeric",
"hue-degree-notation": "number",
"length-zero-no-unit": [
true,
{
"ignore": ["custom-properties"]
}
],
"linebreaks": "unix",
"media-feature-name-no-unknown": null,
"media-feature-range-notation": null,
"media-query-no-invalid": null,
"no-descending-specificity": null,
"no-empty-first-line": true,
"no-unknown-animations": true,
"property-no-unknown": null,
"property-no-vendor-prefix": [
Expand All @@ -87,22 +78,18 @@
}
],
"selector-class-pattern": null,
"selector-combinator-space-before": null,
"selector-descendant-combinator-no-non-space": null,
"selector-id-pattern": null,
"selector-max-empty-lines": 0,
"selector-max-id": 0,
"selector-no-qualifying-type": null,
"selector-pseudo-class-no-unknown": null,
"selector-pseudo-element-no-unknown": null,
"string-quotes": "double",
"unicode-bom": "never",
"unit-allowed-list": [
"%",
"ch",
"dppx",
"deg",
"em",
"fr",
"mm",
"ms",
"px",
Expand All @@ -118,7 +105,6 @@
]
}
],
"value-list-comma-newline-after": null,
"value-no-vendor-prefix": [
true,
{
Expand All @@ -133,8 +119,6 @@
"scss/at-function-pattern": "^[a-z][a-z0-9]*(-[a-z0-9]+)*$",
"scss/at-if-closing-brace-newline-after": "always-last-in-chain",
"scss/at-if-no-null": true,
"scss/at-import-no-partial-leading-underscore": true,
"scss/at-import-partial-extension": "never",
"scss/at-mixin-argumentless-call-parentheses": "always",
"scss/at-mixin-parentheses-space-before": "never",
"scss/at-mixin-pattern": "^[a-z][a-z0-9]*(-[a-z0-9]+)*$",
Expand All @@ -152,12 +136,32 @@
"scss/double-slash-comment-empty-line-before": null,
"scss/double-slash-comment-whitespace-inside": "always",
"scss/at-extend-no-missing-placeholder": null,
"scss/load-partial-extension": "never",
"scss/no-duplicate-mixins": true,
"scss/no-global-function-names": null,
"scss/operator-no-newline-after": null,
"scss/operator-no-unspaced": true,
"scss/partial-no-import": true,
"scss/percent-placeholder-pattern": "^[a-z][a-z0-9]*(-[a-z0-9]+)*$",
"scss/selector-no-redundant-nesting-selector": true
"scss/selector-no-redundant-nesting-selector": true,
"@stylistic/block-closing-brace-newline-after": [
"always",
{
"ignoreAtRules": [
"if",
"else",
"elseif"
]
}
],
"@stylistic/declaration-colon-space-after": null,
"@stylistic/no-empty-first-line": true,
"@stylistic/linebreaks": "unix",
"@stylistic/selector-combinator-space-before": null,
"@stylistic/selector-descendant-combinator-no-non-space": null,
"@stylistic/selector-max-empty-lines": 0,
"@stylistic/string-quotes": "double",
"@stylistic/unicode-bom": "never",
"@stylistic/value-list-comma-newline-after": null
}
}
2 changes: 1 addition & 1 deletion MKDOCS_MATERIAL_MERGE_BASE
Original file line number Diff line number Diff line change
@@ -1 +1 @@
f139b54c61b2df4512f15149cba2c222475e2bc9
396c493f4774fa0bafeada5d0b555d02193557e8
8 changes: 0 additions & 8 deletions docs/_static/extra_css.css
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,6 @@
--md-tooltip-width: 600px;
}

.annotated-with-numbers .md-annotation__index > ::before {
content: attr(data-md-annotation-id);
}

.annotated-with-numbers :focus-within > .md-annotation__index > ::before {
transform: none;
}

/* style for custom font example */
.custom-font-example {
--md-text-font: "Comic Neue";
Expand Down
2 changes: 1 addition & 1 deletion docs/_templates/base.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
<p>
Now includes
<a href="https://squidfunk.github.io/mkdocs-material/changelog/">changes from mkdocs-material theme</a>
v8.5.6
v9.6.5
</p>
{% endblock %}
Loading