Insert screenshots of themes on the right side

Author: oprypin

src/best_of/generators/markdown_list.py

@@ -10,7 +10,7 @@
 
 from best_of import default_config, integrations, utils
 from best_of.generators.base_generator import BaseGenerator
-from best_of.integrations import github_integration
+from best_of.integrations import github_integration, mkdocs_integration
 from best_of.license import get_license
 
 log = logging.getLogger(__name__)
@@ -224,18 +224,19 @@ def generate_project_body(project: Dict, configuration: Dict, labels: list) -> s
  body_md = "\n\n" + body_md
  return body_md
 
+ mkdocs_prefix, mkdocs_body = mkdocs_integration.MkDocsIntegration.generate_md_details(project, configuration)
+ body_md += mkdocs_prefix
+
  if project.github_id:
  body_md += github_integration.generate_github_details(project, configuration)
 
  for package_manager in integrations.AVAILABLE_PACKAGE_MANAGER:
  package_manager_id = package_manager.name.lower().strip() + "_id"
- if (
- package_manager_id in project
- and project[package_manager_id]
- or package_manager.name == "mkdocs"
- ):
+ if package_manager_id in project and project[package_manager_id]:
  body_md += package_manager.generate_md_details(project, configuration)
 
+ body_md += mkdocs_body
+
  if not body_md:
  # show message if no information is available
  body_md = "- _No project information available._"

src/best_of/integrations/__init__.py

@@ -8,7 +8,6 @@
  gitlab_integration,
  go_integration,
  maven_integration,
- mkdocs_integration,
  npm_integration,
  pypi_integration,
 )
@@ -24,7 +23,6 @@
  dockerhub_integration.DockerhubIntegration(),
  cargo_integration.CargoIntegration(),
  go_integration.GoIntegration(),
- mkdocs_integration.MkDocsIntegration(),
 ]
 
 # TODO: "helm_id", "brew_id", "apt_id", "yum_id", "snap_id", "dnf_id", "yay_id",

src/best_of/integrations/mkdocs_integration.py

@@ -1,7 +1,5 @@
 from addict import Dict
 
-from best_of.integrations.base_integration import BaseIntegration
-
 
 def _get_as_list(mapping, key):
  names = mapping.get(key, ())
@@ -10,17 +8,11 @@ def _get_as_list(mapping, key):
  return names
 
 
-class MkDocsIntegration(BaseIntegration):
- @property
- def name(self) -> str:
- return "mkdocs"
-
- def update_project_info(self, project_info: Dict) -> None:
- pass
-
- def generate_md_details(self, project: Dict, configuration: Dict) -> str:
+class MkDocsIntegration:
+ @staticmethod
+ def generate_md_details(project: Dict, configuration: Dict):
  if not configuration.generate_install_hints:
- return ""
+ return "", ""
 
  themes = _get_as_list(project, "mkdocs_theme")
  plugins = _get_as_list(project, "mkdocs_plugin")
@@ -44,9 +36,18 @@ def generate_md_details(self, project: Dict, configuration: Dict) -> str:
  yml += ["markdown_extensions:"] + [f" - {x}" for x in extensions]
 
  if not config_keys:
- return ""
+ return "", ""
  url = f"https://www.mkdocs.org/user-guide/configuration/#{config_keys[0]}"
 
+ if themes:
+ prefix = (
+ f'<a href="https://pawamoy.github.io/mkdocs-gallery/themes/{themes[0]}/">\n'
+ f'<img src="https://pawamoy.github.io/mkdocs-gallery/assets/img/{themes[0]}.png" width="400" align="right">\n'
+ f"</a>\n\n"
+ )
+ else:
+ prefix = ""
+
  lines = [
  f"Add to [mkdocs.yml]({url}):",
  "```yaml",
@@ -60,4 +61,5 @@ def generate_md_details(self, project: Dict, configuration: Dict) -> str:
  *yml_extra,
  "```",
  ]
- return "- " + "".join(f" {line}\n" for line in lines).lstrip()
+ body = "- " + "".join(f" {line}\n" for line in lines).lstrip()
+ return prefix, body