Edit the output style to match the preference for MkDocs

Replaces postprocessing at https://github.com/mkdocs/catalog/blob/57f05e34859a68b47710a7e387c19bf6f1245eed/reformat.py

Author: oprypin

src/best_of/default_config.py

@@ -59,7 +59,7 @@ def prepare_configuration(cfg: dict) -> Dict:
         config.hide_empty_categories = False
 
     if "max_description_length" not in config:
-        config.max_description_length = 55
+        config.max_description_length = 100
 
     if "min_description_length" not in config:
         config.min_description_length = MIN_PROJECT_DESC_LENGTH

src/best_of/generators/markdown_list.py

@@ -83,12 +83,10 @@ def generate_metrics_info(project: Dict, configuration: Dict) -> str:
         metrics_md = status_md
 
     if metrics_md:
-        # add divider if metrics are available
-        metrics_md = "(" + metrics_md + ")"
         # remove unneccesary whitespaces
         utils.clean_whitespaces(metrics_md)
-        # Add whitespace
-        metrics_md = metrics_md + " "
+        # add divider if metrics are available
+        metrics_md = " - " + metrics_md
 
     return metrics_md
 
@@ -153,8 +151,8 @@ def generate_project_labels(project: Dict, labels: list) -> Tuple[str, int]:
             label_md = '<a href="' + label_info.url + '">' + label_md + "</a>"
 
         if label_md:
-            # Add a single space in front of label:
-            labels_md += " " + label_md.strip()
+            # Add a separator between labels:
+            labels_md += " · " + label_md.strip()
             labels_text_length += LABEL_SPACING_LENGTH
 
     return (labels_md, labels_text_length)
@@ -200,7 +198,7 @@ def generate_license_info(project: Dict, configuration: Dict) -> Tuple[str, int]
             license_md += " <code>Unlicensed</code>"
         else:
             license_md += " <code>❗Unlicensed</code>"
-    return license_md, license_length
+    return " ·" + license_md, license_length
 
 
 def generate_project_body(project: Dict, configuration: Dict, labels: list) -> str:
@@ -258,7 +256,6 @@ def generate_project_md(
 
     metadata_md = ""
     if license_md and labels_md:
-        # TODO: add " · " in between?
         metadata_md = license_md + labels_md
     elif license_md:
         metadata_md = license_md
@@ -276,41 +273,25 @@ def generate_project_md(
     if project.labels:
         label_count = len(project.labels)
 
-    if license_len:
-        # Add spacing to length
-        license_len += 2
-
-    desc_length = int(
-        round(
-            max(
-                configuration.max_description_length,
-                105
-                - (len(project.name) * 1.3)
-                - len(metrics_md)
-                - license_len
-                - (label_count * 5),
-            )
-        )
-    )
     description = utils.process_description(
         project.description,
-        desc_length,
+        configuration.max_description_length,
         ascii_only=configuration.ascii_description,
     )
 
     # target="_blank"
+    if description:
+        description = f"<br>{description}"
     if project.resource:
-        if description:
-            description = f"- {description}"
-        project_md = '🔗&nbsp;<b><a href="{homepage}">{name}</a></b> {metrics} {description}{metadata}\n'.format(
+        project_md = '🔗&nbsp;<b><a href="{homepage}">{name}</a></b> {metrics}{metadata}{description}\n'.format(
             homepage=project.homepage,
             name=project.name,
             description=description,
             metrics=metrics_md,
             metadata=metadata_md,
         )
     elif generate_body:
-        project_md = '<details><summary><b><a href="{homepage}">{name}</a></b> {metrics}- {description}{metadata}</summary>{body}</details>'.format(
+        project_md = '<details><summary><b><a href="{homepage}">{name}</a></b> {metrics}{metadata}{description}</summary>{body}</details>'.format(
             homepage=project.homepage,
             name=project.name,
             description=description,
@@ -320,7 +301,7 @@ def generate_project_md(
         )
     else:
         # don't use details format
-        project_md = '- <b><a href="{homepage}">{name}</a></b> {metrics}- {description}{metadata}'.format(
+        project_md = '- <b><a href="{homepage}">{name}</a></b> {metrics}{metadata}{description}'.format(
             homepage=project.homepage,
             name=project.name,
             description=description,