diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000000000000000000000000000000000000..44ce3acc5304da0e3d343556d34d184837a2cc87 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,91 @@ +site_name: Silkaj +site_url: https://silkaj.duniter.org +repo_url: https://git.duniter.org/clients/python/silkaj +copyright: "Copyright © 2016 − 2025 Maël Azimi" +repo_name: GitLab +remote_branch: "pages" +site_description: "Command line client for Ğ1 libre-currency powered by Duniter" +theme: + name: material + logo: images/silkaj_logo.png + favicon: images/silkaj_logo.png + features: + - navigation.tracking + - navigation.tabs + - navigation.tabs.sticky + - navigation.sections + - content.code.copy + - content.tabs.link + font: false + palette: + - media: "(prefers-color-scheme: dark)" + scheme: default + toggle: + icon: material/brightness-4 + name: Switch to light mode + - media: "(prefers-color-scheme: light)" + scheme: slate + toggle: + icon: material/brightness-7 + name: Switch to dark mode +markdown_extensions: + - attr_list + - md_in_html + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences + - pymdownx.tabbed: + alternate_style: true + - toc: + permalink: true +nav: + - index.md + - Installation: install_pipx.md + - Usage: + - how-to_automate_transactions_and_multi-output.md + - DeathReaper: deathreaper.md + - Blog: + - blog/index.md + - Changelog: changelog.md + - Contributing: + - contributing.md + - Poetry installation: install_poetry.md + - Docker installation: docker.md + - Documentation: documentation.md + - test_and_coverage.md + - Coverage report: coverage.md + +extra: + version: + provider: mike + social: + - icon: fontawesome/brands/gitlab + link: https://git.duniter.org/clients/python/silkaj + name: Git repository + - icon: fontawesome/brands/python + link: https://pypi.org/project/silkaj/ + name: PyPI + - icon: simple/discourse + link: https://forum.duniter.org + name: Duniter forum + - icon: simple/xmpp + link: https://chat.duniter.org + name: Duniter XMPP chatroom + +plugins: + - blog: + pagination_per_page: 5 + blog_toc: true + post_url_format: "{slug}" + archive_url_format: "{date}" + categories_url_format: "{slug}" + - coverage + - gitlab_links: + gitlab_url: "https://git.duniter.org/clients/python/silkaj"