diff --git a/.editorconfig b/.editorconfig index c56b17f..eaff743 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,4 +1,4 @@ -# Copyright (c) 2022 Martin Donath +# Copyright (c) 2016-2023 Martin Donath # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 786c4c8..958523e 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,4 +1,4 @@ -# Copyright (c) 2022 Martin Donath +# Copyright (c) 2016-2023 Martin Donath # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 0000000..881afda --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,81 @@ +# Copyright (c) 2016-2023 Martin Donath + +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to +# deal in the Software without restriction, including without limitation the +# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +# sell copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: + +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. + +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +# IN THE SOFTWARE. + +name: documentation +on: + push: + branches: + - master + +env: + PYTHON_VERSION: 3.x + +permissions: + contents: write + +jobs: + documentation: + name: Build documentation + runs-on: ubuntu-latest + steps: + + - name: Checkout repository + uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: Set up Python runtime + uses: actions/setup-python@v4 + with: + python-version: ${{ env.PYTHON_VERSION }} + + - name: Set the date environmental variable + run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV + + - name: Set up build cache + uses: actions/cache@v3 + id: cache + with: + key: mkdocs-material-${{ env.cache_id }} + path: .cache + restore-keys: | + mkdocs-material- + + - name: Install dependencies + run: sudo apt-get install pngquant + + - name: Install Python dependencies + run: pip install -r requirements.txt + + - name: Install Insiders + if: github.event.repository.fork == false + env: + GH_TOKEN: ${{ secrets.GH_TOKEN }} + run: | + pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git + + - name: Deploy documentation + env: + GH_TOKEN: ${{ secrets.GH_TOKEN }} + PYTHONPATH: . + # GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }} + run: | + mkdocs gh-deploy --force + mkdocs --version diff --git a/.gitignore b/.gitignore index 82cf9f2..b536c0a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ -# Copyright (c) 2016-2022 Martin Donath +# Copyright (c) 2016-2023 Martin Donath # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to @@ -25,6 +25,13 @@ # Dependencies /venv +# Build files +build +site + +# Generated files +*.zip + # Caches and logs *.log .cache diff --git a/LICENSE b/LICENSE index 55bed94..e409407 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2022 Martin Donath +Copyright (c) 2016-2023 Martin Donath Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to diff --git a/docs/index.md b/docs/index.md index aca4d98..4f5b689 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# Example +# Examples This project lists all options that are supported by Material for MkDocs and can be used as a basis for new projects or reproductions. Note that some options @@ -8,6 +8,3 @@ to be sure. [sponsors]: https://squidfunk.github.io/mkdocs-material/insiders/ [available features]: https://squidfunk.github.io/mkdocs-material/insiders/#whats-in-for-me -``` yaml ---8<-- "mkdocs.yml" -``` diff --git a/examples/__init__.py b/examples/__init__.py new file mode 100644 index 0000000..03404ae --- /dev/null +++ b/examples/__init__.py @@ -0,0 +1,54 @@ +# Copyright (c) 2016-2023 Martin Donath + +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to +# deal in the Software without restriction, including without limitation the +# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +# sell copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: + +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. + +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +# IN THE SOFTWARE. + +import os +import posixpath + +from mergedeep import merge +from mkdocs.config.defaults import MkDocsConfig + +# ----------------------------------------------------------------------------- +# Functions +# ----------------------------------------------------------------------------- + +# Transform project configuration +def transform(project: MkDocsConfig, config: MkDocsConfig): + root = os.path.dirname(project.config_file_path) + name = os.path.basename(root) + + # Inherit settings for repository + project.repo_name = config.repo_name + project.repo_url = config.repo_url + + # Inherit settings for site URL and edit URI + project.site_url = posixpath.join(config.site_url, name, "") + project.edit_uri = f"edit/master/examples/{name}/docs/" + + # Inherit settings for copyright + project.copyright = config.copyright + + # Inherit settings for theme + merge(project.theme["icon"], config.theme["icon"]) + project.theme["features"].extend(config.theme["features"]) + + root = os.path.dirname(config.config_file_path) + project.hooks = [ + os.path.join(root, "hooks", "zip.py") + ] diff --git a/packages/tags-with-icons/docs/README.md b/examples/tags-with-icons/docs/README.md similarity index 57% rename from packages/tags-with-icons/docs/README.md rename to examples/tags-with-icons/docs/README.md index a3b0a66..bc33c1c 100644 --- a/packages/tags-with-icons/docs/README.md +++ b/examples/tags-with-icons/docs/README.md @@ -10,12 +10,12 @@ This example includes the following pages: - [Page 2] – Page with tags [JavaScript] and [CSS] - [Tags] – Tags index - [Page 1]: pages/page-1.md - [Page 2]: pages/page-2.md - [Tags]: pages/tags.md - [HTML]: pages/tags.md#html - [JavaScript]: pages/tags.md#javascript - [CSS]: pages/tags.md#css + [Page 1]: demo/page-1.md + [Page 2]: demo/page-2.md + [Tags]: demo/tags.md + [HTML]: demo/tags.md#html + [JavaScript]: demo/tags.md#javascript + [CSS]: demo/tags.md#css Download example as archive: @@ -28,4 +28,4 @@ pip install -r requirements.txt mkdocs serve ``` - [Download]: https://minhaskamal.github.io/DownGit/#/home?url=https://github.com/mkdocs-material/examples/tree/master/examples/tags + [Download]: download.zip diff --git a/packages/tags-with-icons/docs/pages/page-1.md b/examples/tags-with-icons/docs/demo/page-1.md similarity index 100% rename from packages/tags-with-icons/docs/pages/page-1.md rename to examples/tags-with-icons/docs/demo/page-1.md diff --git a/packages/tags-with-icons/docs/pages/page-2.md b/examples/tags-with-icons/docs/demo/page-2.md similarity index 100% rename from packages/tags-with-icons/docs/pages/page-2.md rename to examples/tags-with-icons/docs/demo/page-2.md diff --git a/packages/tags-with-icons/docs/pages/tags.md b/examples/tags-with-icons/docs/demo/tags.md similarity index 100% rename from packages/tags-with-icons/docs/pages/tags.md rename to examples/tags-with-icons/docs/demo/tags.md diff --git a/packages/tags-with-icons/mkdocs.yml b/examples/tags-with-icons/mkdocs.yml similarity index 87% rename from packages/tags-with-icons/mkdocs.yml rename to examples/tags-with-icons/mkdocs.yml index 53a9096..be9ad0a 100644 --- a/packages/tags-with-icons/mkdocs.yml +++ b/examples/tags-with-icons/mkdocs.yml @@ -1,4 +1,4 @@ -# Copyright (c) 2022 Martin Donath +# Copyright (c) 2016-2023 Martin Donath # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to @@ -25,11 +25,6 @@ # Project information site_name: Using tags with icons -# Repository -repo_name: mkdocs-material/examples -repo_url: https://github.com/mkdocs-material/examples -edit_uri: edit/master/examples/tags-with-icons/docs - # Theme theme: name: material @@ -45,7 +40,7 @@ theme: plugins: - search - tags: - tags_file: pages/tags.md + tags_file: demo/tags.md # Extra configuration extra: diff --git a/packages/tags-with-icons/requirements.txt b/examples/tags-with-icons/requirements.txt similarity index 93% rename from packages/tags-with-icons/requirements.txt rename to examples/tags-with-icons/requirements.txt index 2682523..df8b44f 100644 --- a/packages/tags-with-icons/requirements.txt +++ b/examples/tags-with-icons/requirements.txt @@ -1,4 +1,4 @@ -# Copyright (c) 2022 Martin Donath +# Copyright (c) 2016-2023 Martin Donath # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to diff --git a/packages/tags/docs/README.md b/examples/tags/docs/README.md similarity index 57% rename from packages/tags/docs/README.md rename to examples/tags/docs/README.md index d15c0fd..eadc982 100644 --- a/packages/tags/docs/README.md +++ b/examples/tags/docs/README.md @@ -10,12 +10,12 @@ This example includes the following pages: - [Page 2] – Page with tags [JavaScript] and [CSS] - [Tags] – Tags index - [Page 1]: pages/page-1.md - [Page 2]: pages/page-2.md - [Tags]: pages/tags.md - [HTML]: pages/tags.md#html - [JavaScript]: pages/tags.md#javascript - [CSS]: pages/tags.md#css + [Page 1]: demo/page-1.md + [Page 2]: demo/page-2.md + [Tags]: demo/tags.md + [HTML]: demo/tags.md#html + [JavaScript]: demo/tags.md#javascript + [CSS]: demo/tags.md#css Download example as archive: @@ -28,4 +28,4 @@ pip install -r requirements.txt mkdocs serve ``` - [Download]: https://minhaskamal.github.io/DownGit/#/home?url=https://github.com/mkdocs-material/examples/tree/master/examples/tags + [Download]: download.zip diff --git a/packages/tags/docs/pages/page-1.md b/examples/tags/docs/demo/page-1.md similarity index 100% rename from packages/tags/docs/pages/page-1.md rename to examples/tags/docs/demo/page-1.md diff --git a/packages/tags/docs/pages/page-2.md b/examples/tags/docs/demo/page-2.md similarity index 100% rename from packages/tags/docs/pages/page-2.md rename to examples/tags/docs/demo/page-2.md diff --git a/packages/tags/docs/pages/tags.md b/examples/tags/docs/demo/tags.md similarity index 100% rename from packages/tags/docs/pages/tags.md rename to examples/tags/docs/demo/tags.md diff --git a/packages/tags/mkdocs.yml b/examples/tags/mkdocs.yml similarity index 83% rename from packages/tags/mkdocs.yml rename to examples/tags/mkdocs.yml index 92edd0f..be9ad0a 100644 --- a/packages/tags/mkdocs.yml +++ b/examples/tags/mkdocs.yml @@ -1,4 +1,4 @@ -# Copyright (c) 2022 Martin Donath +# Copyright (c) 2016-2023 Martin Donath # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to @@ -23,24 +23,31 @@ # ----------------------------------------------------------------------------- # Project information -site_name: Using tags - -# Repository -repo_name: mkdocs-material/examples -repo_url: https://github.com/mkdocs-material/examples -edit_uri: edit/master/examples/tags/docs +site_name: Using tags with icons # Theme theme: name: material features: - navigation.sections + icon: + tag: + css: simple/css3 + html: simple/html5 + js: simple/javascript # Plugins plugins: - search - tags: - tags_file: pages/tags.md + tags_file: demo/tags.md + +# Extra configuration +extra: + tags: + CSS: css + HTML: html + JavaScript: js # Markdown extensions markdown_extensions: diff --git a/packages/tags/requirements.txt b/examples/tags/requirements.txt similarity index 93% rename from packages/tags/requirements.txt rename to examples/tags/requirements.txt index 2682523..df8b44f 100644 --- a/packages/tags/requirements.txt +++ b/examples/tags/requirements.txt @@ -1,4 +1,4 @@ -# Copyright (c) 2022 Martin Donath +# Copyright (c) 2016-2023 Martin Donath # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to diff --git a/hooks/zip.py b/hooks/zip.py new file mode 100644 index 0000000..8eb9654 --- /dev/null +++ b/hooks/zip.py @@ -0,0 +1,55 @@ +# Copyright (c) 2016-2023 Martin Donath + +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to +# deal in the Software without restriction, including without limitation the +# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +# sell copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: + +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. + +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +# IN THE SOFTWARE. + +import os + +from glob import iglob +from mkdocs.config.defaults import MkDocsConfig +from zipfile import ZipFile, ZIP_DEFLATED + +# ----------------------------------------------------------------------------- +# Hooks +# ----------------------------------------------------------------------------- + +# Create an archive +def on_pre_build(config: MkDocsConfig): + base = os.path.dirname(config.config_file_path) + project_name = os.path.basename(base) + + archive = f"{config.docs_dir}/download.zip" + with ZipFile(archive, "w", ZIP_DEFLATED, False) as f: + for name in os.listdir(base): + # @todo: load ignore patterns from .gitignore + if name == "site": + continue + if name.endswith(".zip"): + continue + + # Find all files recursively and add them to the archive + path = os.path.join(base, name) + if os.path.isdir(path): + path = os.path.join(path, "**") + + # @todo + for file in iglob(path, recursive = True): + f.write( + file, + os.path.join(project_name, os.path.relpath(file, base)) + ) diff --git a/mkdocs.yml b/mkdocs.yml index d62b45c..8e52780 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,4 @@ -# Copyright (c) 2022 Martin Donath +# Copyright (c) 2016-2023 Martin Donath # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to @@ -18,321 +18,53 @@ # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. -# ----------------------------------------------------------------------------- -# Recommended: set up configuration validation, see https://bit.ly/3WT2GkR -# ----------------------------------------------------------------------------- - # Project information -site_name: Example -# site_url: https://example.com/ +site_name: Material for MkDocs +site_url: https://mkdocs-material.github.io/examples/ site_author: Martin Donath site_description: >- - This project lists all options that are supported by Material for MkDocs - and can be used as a basis for new projects or reproductions. + An ever-growing collection of self-contained example uses of Material for + MkDocs that you can download and run to get started quickly # Repository repo_name: mkdocs-material/examples repo_url: https://github.com/mkdocs-material/examples -# edit_uri: edit/master/docs/ # Copyright -copyright: Copyright © 2022 Martin Donath - -# Directories -# docs_dir: docs -# site_dir: site -# use_directory_urls: false - -# Runtime -# strict: true -# dev_addr: 127.0.0.1:8000 - -# Deployment -# remote_branch: gh-pages -# remote_name: origin - -# Extra assets -# extra_css: [extra.css] -# extra_javascript: [extra.js] +copyright: Copyright © 2016 - 2023 Martin Donath # Theme theme: name: material - # custom_dir: overrides - # static_templates: - # - 404.html - - # Language and directionality - language: en - # direction: ltr - - # Favicon and logo - # favicon: path/to/file.png - # logo: path/to/file.png - - # Icons - icon: - # edit: material/pencil - logo: material/library - # repo: fontawesome/brands/git-alt - # admonition: - # note: material/pencil - # abstract: material/clipboard-text - # info: material/information - # tip: material/fire - # success: material/check-bold - # question: material/help-circle - # warning: material/alert - # failure: material/close - # danger: material/lightning-bolt-circle - # bug: material/shield-bug - # example: material/test-tube - # quote: material/format-quote-close - - # Feature flags features: - # - announce.dismiss - - content.code.annotate - # - content.code.copy - # - content.tabs.link - # - content.tooltips - # - header.autohide - # - navigation.expand - # - navigation.footer + - content.action.edit + - content.action.view + - content.tooltips - navigation.indexes - # - navigation.instant - # - navigation.prune - # - navigation.sections - # - navigation.tabs - # - navigation.tabs.sticky - # - navigation.top - # - navigation.tracking - # - search.highlight - # - search.share - # - search.suggest - # - toc.follow - # - toc.integrate - - # Color palette - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - primary: indigo - accent: indigo - toggle: - icon: material/brightness-7 - name: Switch to dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: indigo - accent: indigo - toggle: - icon: material/brightness-4 - name: Switch to light mode - - # Google Fonts - # font: - # text: Roboto - # code: Roboto Mono + - navigation.sections + icon: + logo: logo # Plugins plugins: + - projects: + cache: false + projects_dir: examples + projects_config_transform: !!python/name:examples.transform - # Built-in plugin: blog - # - blog: - # enabled: true - # blog_dir: blog - # post_date_format: long - # post_url_date_format: yyyy/MM/dd - # post_url_format: "{date}/{slug}" - # post_excerpt: optional - # post_excerpt_separator: - # post_excerpt_max_authors: 1 - # post_excerpt_max_categories: 5 - # post_readtime: true - # post_readtime_words_per_minute: 265 - # archive: true - # archive_name: Archive - # archive_date_format: yyyy - # archive_url_date_format: yyyy - # archive_url_format: "archive/{date}" - # categories: true - # categories_name: Categories - # categories_url_format: "category/{slug}" - # categories_allowed: [] - # pagination: true - # pagination_per_page: 10 - # pagination_url_format: "page/{page}" - # pagination_template: ~2~ - # pagination_keep_content: false - # authors: true - # authors_file: .authors.yml - # draft: true - # draft_on_serve: true - # draft_if_future_date: false - - # Built-in plugin: meta - # - meta: - # meta_file: "**/.meta.yml" - - # Built-in plugin: offline - # - offline: - # enabled: true - - # Built-in plugin: privacy - # - privacy: - # enabled: true - # external_assets: bundle - # external_assets_dir: assets/external - # external_links: true - # external_links_attr_map: {} - # external_links_noopener: true - - # Built-in plugin: search - - search: - lang: en - separator: '[\s-]+' - - # Built-in plugin: social - # - social: - # cards: true - # cards_dir: assets/images/social - # cards_font: Roboto - # cards_color: - # fill: black - # text: white - - # Built-in plugin: tags - # - tags: - # enabled: true - # tags_file: tags.md - # tags_extra_files: {} - # tags_allowed: [] - - # Plugin: mkdocs-git-committers-plugin-2 - # - git-committers: - # enabled: true - # repository: mkdocs-material/examples - # branch: master - - # Plugin: mkdocs-git-revision-date-localized-plugin - # - git-revision-date-localized: - # enabled: true - # type: date - # exclude: [] - # fallback_to_build_date: false - # enable_creation_date: false - - # Plugin: mkdocs-glightbox - # - glightbox: - # touchNavigation: true - # loop: false - # effect: zoom - # width: "100%" - # height: auto - # zoomable: true - # draggable: true - # auto_caption: false - # caption_position: bottom - - # Plugin: mkdocs-minify-plugin - # - minify: - # minify_html: true - - # Plugin: mkdocs-redirects - # - redirects: - # redirect_maps: - # old.md: new.md - - # Plugin: mkdocs-rss-plugin - # - rss: - # enabled: true - # abstract_chars_count: 160 - # feed_ttl: 1440 - # length: 20 - # match_path: .* - # pretty_print: false - -# Extra configuration +# Customization extra: - - # Site analytics analytics: provider: google property: !ENV GOOGLE_ANALYTICS_KEY - # feedback: - # title: Was this page helpful - # ratings: - # - icon: material/emoticon-happy-outline - # name: This page was helpful - # data: 1 - # note: Thanks for your feedback! - # - icon: material/emoticon-sad-outline - # name: This page could be improved - # data: 0 - # note: Thanks for your feedback! - # Cookie consent - # consent: - # title: Cookie consent - # description: >- - # We use cookies to recognize your repeated visits and preferences, as - # well as to measure the effectiveness of our documentation and whether - # users find what they're searching for. With your consent, you're - # helping us to make our documentation better. - # actions: - # - accept - # - manage - - # Social links - # social: - # - icon: fontawesome/brands/github - # link: https://github.com/squidfunk - # - icon: fontawesome/brands/gitter - # link: https://gitter.im/squidfunk/mkdocs-material - # - icon: fontawesome/brands/docker - # link: https://hub.docker.com/r/squidfunk/mkdocs-material/ - # - icon: fontawesome/brands/python - # link: https://pypi.org/project/mkdocs-material/ - # - icon: fontawesome/brands/twitter - # link: https://twitter.com/squidfunk - - # Site language selector - # alternate: - # - name: English - # link: /en/ - # lang: en - # - name: Deutsch - # link: /de/ - # lang: de - - # Tag identifiers - # tags: {} - - # Versioning - # version: - # provider: mike - - # Generator notice - # generator: true - -# Markdown extensions +# Extensions markdown_extensions: - - # Python Markdown - - abbr - admonition - attr_list - - def_list - footnotes - - md_in_html - - tables - toc: permalink: true - - # Python Markdown Extensions - - pymdownx.arithmatex: - generic: true - pymdownx.betterem: smart_enable: all - pymdownx.details @@ -341,22 +73,6 @@ markdown_extensions: emoji_index: !!python/name:materialx.emoji.twemoji - pymdownx.highlight: anchor_linenums: true - - pymdownx.inlinehilite - pymdownx.keys - - pymdownx.magiclink: - repo_url_shorthand: true - user: mkdocs-material - repo: examples - - pymdownx.mark - - pymdownx.smartsymbols - - pymdownx.snippets - - pymdownx.superfences: - custom_fences: - - name: mermaid - class: mermaid - format: !!python/name:pymdownx.superfences.fence_code_format - pymdownx.tabbed: alternate_style: true - - pymdownx.tasklist: - custom_checkbox: true - - pymdownx.tilde diff --git a/requirements.txt b/requirements.txt index db0c087..9dfda0e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -# Copyright (c) 2022 Martin Donath +# Copyright (c) 2016-2023 Martin Donath # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to @@ -19,14 +19,15 @@ # IN THE SOFTWARE. # Requirements for core +mergedeep mkdocs-material cairosvg pillow -# Requirements for plugins +# Requirements for integrations mkdocs-git-committers-plugin-2 mkdocs-git-revision-date-localized-plugin mkdocs-glightbox mkdocs-minify-plugin -mkdocs-rss-plugin mkdocs-redirects +mkdocs-rss-plugin