-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
misc: Produce extra admonition types with Python script
- Loading branch information
Showing
5 changed files
with
103 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| :root { | ||
| --md-admonition-icon--comment: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9 22a1 1 0 0 1-1-1v-3H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h16a2 2 0 0 1 2 2v12a2 2 0 0 1-2 2h-6.1l-3.7 3.71c-.2.19-.45.29-.7.29H9Z"/></svg>'); | ||
| } | ||
|
|
||
| .md-typeset { | ||
| .admonition.comment, | ||
| details.comment { | ||
| border-color: rgb(43, 155, 70); | ||
| } | ||
|
|
||
| .comment > .admonition-title, | ||
| .comment > summary { | ||
| background-color: rgba(43, 155, 70, 0.1); | ||
|
|
||
| &::before { | ||
| background-color: rgb(43, 155, 70); | ||
| -webkit-mask-image: var(--md-admonition-icon--comment); | ||
| mask-image: var(--md-admonition-icon--comment); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| #!/usr/bin/env python3 | ||
|
|
||
| import inspect | ||
| import os | ||
|
|
||
| import material | ||
|
|
||
|
|
||
| CUSTOM_ADMONITIONS = { | ||
| "comment": { | ||
| "icon": "material/comment", | ||
| "rgb": [43, 155, 70], | ||
| }, | ||
| } | ||
|
|
||
| # ensure we're in project root directory | ||
| if not os.path.isfile("mkdocs.yml"): | ||
| raise FileNotFoundError("mkdocs.yml not found") | ||
|
|
||
|
|
||
| material_root = os.path.dirname(inspect.getfile(material)) | ||
| material_root = os.path.join(material_root, "templates", ".icons") | ||
|
|
||
|
|
||
| def get_icon(name): | ||
| with open(os.path.join(material_root, name + ".svg")) as f: | ||
| return f.read() | ||
|
|
||
|
|
||
| root_defs = [] | ||
| typeset_defs = [] | ||
| for name, data in CUSTOM_ADMONITIONS.items(): | ||
| varname = f"--md-admonition-icon--{name}" | ||
| content = get_icon(data["icon"]) | ||
| s = f" {varname}: url('data:image/svg+xml;charset=utf-8,{content}');" | ||
| root_defs.append(s) | ||
|
|
||
| rgb = data["rgb"] | ||
| rgb_s = f"{rgb[0]}, {rgb[1]}, {rgb[2]}" | ||
| s = f""" | ||
| .admonition.{name}, | ||
| details.{name} {{ | ||
| border-color: rgb({rgb_s}); | ||
| }} | ||
| .{name} > .admonition-title, | ||
| .{name} > summary {{ | ||
| background-color: rgba({rgb_s}, 0.1); | ||
| &::before {{ | ||
| background-color: rgb({rgb_s}); | ||
| -webkit-mask-image: var({varname}); | ||
| mask-image: var({varname}); | ||
| }} | ||
| }}""".lstrip("\n") | ||
| typeset_defs.append(s) | ||
|
|
||
| with open("docs/css/admonitions.scss", "w") as f: | ||
| print(":root {", file=f) | ||
| print("\n".join(root_defs), file=f) | ||
| print("}", file=f, end="\n\n") | ||
|
|
||
| print(".md-typeset {", file=f) | ||
| print("\n\n".join(typeset_defs), file=f) | ||
| print("}", file=f) |