OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
squidfunk
2024-01-28 15:51:25 +07:00
parent 6026738819
commit 294d38e8d3
14 changed files with 37 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/reference/admonitions.md
View File

@@ -24,9 +24,9 @@ markdown_extensions:
See additional configuration options: See additional configuration options:
- [Admonition] - [Admonition]{ data-preview="" }
- [Details] - [Details]{ data-preview="" }
- [SuperFences] - [SuperFences]{ data-preview="" }
[Admonition]: ../setup/extensions/python-markdown.md#admonition [Admonition]: ../setup/extensions/python-markdown.md#admonition
[Details]: ../setup/extensions/python-markdown-extensions.md#details [Details]: ../setup/extensions/python-markdown-extensions.md#details

6
docs/reference/annotations.md
View File

@@ -23,9 +23,9 @@ markdown_extensions:
See additional configuration options: See additional configuration options:
- [Attribute Lists] - [Attribute Lists]{ data-preview="" }
- [Markdown in HTML] - [Markdown in HTML]{ data-preview="" }
- [SuperFences] - [SuperFences]{ data-preview="" }
[Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists [Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists
[Markdown in HTML]: ../setup/extensions/python-markdown.md#markdown-in-html [Markdown in HTML]: ../setup/extensions/python-markdown.md#markdown-in-html

2
docs/reference/buttons.md
View File

@@ -21,7 +21,7 @@ markdown_extensions:
See additional configuration options: See additional configuration options:
- [Attribute Lists] - [Attribute Lists]{ data-preview="" }
[Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists [Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists

8
docs/reference/code-blocks.md
View File

@@ -34,10 +34,10 @@ JavaScript syntax highlighter.
See additional configuration options: See additional configuration options:
- [Highlight] - [Highlight]{ data-preview="" }
- [InlineHilite] - [InlineHilite]{ data-preview="" }
- [SuperFences] - [SuperFences]{ data-preview="" }
- [Snippets] - [Snippets]{ data-preview="" }
[Highlight]: ../setup/extensions/python-markdown-extensions.md#highlight [Highlight]: ../setup/extensions/python-markdown-extensions.md#highlight
[InlineHilite]: ../setup/extensions/python-markdown-extensions.md#inlinehilite [InlineHilite]: ../setup/extensions/python-markdown-extensions.md#inlinehilite

4
docs/reference/content-tabs.md
View File

@@ -24,8 +24,8 @@ markdown_extensions:
See additional configuration options: See additional configuration options:
- [SuperFences] - [SuperFences]{ data-preview="" }
- [Tabbed] - [Tabbed]{ data-preview="" }
[SuperFences]: ../setup/extensions/python-markdown-extensions.md#superfences [SuperFences]: ../setup/extensions/python-markdown-extensions.md#superfences
[Tabbed]: ../setup/extensions/python-markdown-extensions.md#tabbed [Tabbed]: ../setup/extensions/python-markdown-extensions.md#tabbed

2
docs/reference/data-tables.md
View File

@@ -24,7 +24,7 @@ markdown_extensions:
See additional configuration options: See additional configuration options:
- [Tables] - [Tables]{ data-preview="" }
[Tables]: ../setup/extensions/python-markdown.md#tables [Tables]: ../setup/extensions/python-markdown.md#tables

2
docs/reference/footnotes.md
View File

@@ -22,7 +22,7 @@ markdown_extensions:
See additional configuration options: See additional configuration options:
- [Footnotes] - [Footnotes]{ data-preview="" }
[Footnotes]: ../setup/extensions/python-markdown.md#footnotes [Footnotes]: ../setup/extensions/python-markdown.md#footnotes

6
docs/reference/formatting.md
View File

@@ -28,9 +28,9 @@ markdown_extensions:
See additional configuration options: See additional configuration options:
- [Critic] - [Critic]{ data-preview="" }
- [Caret, Mark & Tilde] - [Caret, Mark & Tilde]{ data-preview="" }
- [Keys] - [Keys]{ data-preview="" }
[Critic]: ../setup/extensions/python-markdown-extensions.md#critic [Critic]: ../setup/extensions/python-markdown-extensions.md#critic
[Caret, Mark & Tilde]: ../setup/extensions/python-markdown-extensions.md#caret-mark-tilde [Caret, Mark & Tilde]: ../setup/extensions/python-markdown-extensions.md#caret-mark-tilde

4
docs/reference/grids.md
View File

@@ -26,8 +26,8 @@ markdown_extensions: # (1)!
See additional configuration options: See additional configuration options:
- [Attribute Lists] - [Attribute Lists]{ data-preview="" }
- [Markdown in HTML] - [Markdown in HTML]{ data-preview="" }
[icons and emojis]: icons-emojis.md [icons and emojis]: icons-emojis.md
[configured separately]: icons-emojis.md#configuration [configured separately]: icons-emojis.md#configuration

4
docs/reference/images.md
View File

@@ -23,8 +23,8 @@ markdown_extensions:
See additional configuration options: See additional configuration options:
- [Attribute Lists] - [Attribute Lists]{ data-preview="" }
- [Markdown in HTML] - [Markdown in HTML]{ data-preview="" }
[Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists [Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists
[Markdown in HTML]: ../setup/extensions/python-markdown.md#markdown-in-html [Markdown in HTML]: ../setup/extensions/python-markdown.md#markdown-in-html

4
docs/reference/lists.md
View File

@@ -24,8 +24,8 @@ markdown_extensions:
See additional configuration options: See additional configuration options:
- [Definition Lists] - [Definition Lists]{ data-preview="" }
- [Tasklist] - [Tasklist]{ data-preview="" }
[Definition Lists]: ../setup/extensions/python-markdown.md#definition-lists [Definition Lists]: ../setup/extensions/python-markdown.md#definition-lists
[Tasklist]: ../setup/extensions/python-markdown-extensions.md#tasklist [Tasklist]: ../setup/extensions/python-markdown-extensions.md#tasklist

6
docs/reference/tooltips.md
View File

@@ -25,9 +25,9 @@ markdown_extensions:
See additional configuration options: See additional configuration options:
- [Abbreviations] - [Abbreviations]{ data-preview="" }
- [Attribute Lists] - [Attribute Lists]{ data-preview="" }
- [Snippets] - [Snippets]{ data-preview="" }
[Abbreviations]: ../setup/extensions/python-markdown.md#abbreviations [Abbreviations]: ../setup/extensions/python-markdown.md#abbreviations
[Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists [Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists

1
material/overrides/hooks/shortcodes.py
View File

@@ -113,6 +113,7 @@ def _resolve(file: File, page: Page):
# Create badge # Create badge
def _badge(icon: str, text: str = "", type: str = ""): def _badge(icon: str, text: str = "", type: str = ""):
classes = f"mdx-badge mdx-badge--{type}" if type else "mdx-badge" classes = f"mdx-badge mdx-badge--{type}" if type else "mdx-badge"
text = f"{text}{{ data-preview='' }}" if text.endswith(")") else text
return "".join([ return "".join([
f"<span class=\"{classes}\">", f"<span class=\"{classes}\">",
*([f"<span class=\"mdx-badge__icon\">{icon}</span>"] if icon else []), *([f"<span class=\"mdx-badge__icon\">{icon}</span>"] if icon else []),

1
src/overrides/hooks/shortcodes.py
View File

@@ -113,6 +113,7 @@ def _resolve(file: File, page: Page):
# Create badge # Create badge
def _badge(icon: str, text: str = "", type: str = ""): def _badge(icon: str, text: str = "", type: str = ""):
classes = f"mdx-badge mdx-badge--{type}" if type else "mdx-badge" classes = f"mdx-badge mdx-badge--{type}" if type else "mdx-badge"
text = f"{text}{{ data-preview='' }}" if text.endswith(")") else text
return "".join([ return "".join([
f"<span class=\"{classes}\">", f"<span class=\"{classes}\">",
*([f"<span class=\"mdx-badge__icon\">{icon}</span>"] if icon else []), *([f"<span class=\"mdx-badge__icon\">{icon}</span>"] if icon else []),