feat: support of callouts+custom attributes

Author: Mara-Li

README.md

@@ -45,6 +45,28 @@ extra_css:
 ```
 You can find an example of custom css in [docs](docs/embed_link.css)
 
+# Configuration
+If you want, you can add compatibility with : 
+- [mkdocs callouts](https://github.com/sondregronas/mkdocs-callouts)
+- [mkdocs custom tags attributes](https://github.com/Mara-Li/mkdocs-custom-tags-attributes)
+
+To do that, adjust your `mkdocs.yml`
+```yaml
+markdown_extensions:
+   - attr_list
+   - nl2br
+   - admonition
+   - pymdownx.details
+plugins:
+   - search
+   - callouts
+   - custom-attributes:
+        file: 'assets/css/custom_attributes.css'
+   - embed_file:
+        callouts: true
+        custom-attribute: 'assets/css/custom_attributes.css' //need to be the same as in the config!
+```
+
 # Limitation
 - The embed file don't use plugin you would use.
 - Wikilinks ambiguity are not supported : the first file with the name are used.

mkdocs_embed_file_plugins/plugin.py

@@ -4,13 +4,15 @@
 from glob import iglob
 from pathlib import Path
 from urllib.parse import unquote, quote
-
+import ast
 import frontmatter
 import markdown
 from bs4 import BeautifulSoup
 from mdx_wikilink_plus.mdx_wikilink_plus import WikiLinkPlusExtension
 from mkdocs.config import config_options
 from mkdocs.plugins import BasePlugin
+from mkdocs_callouts.plugin import CalloutsPlugin
+from custom_attributes.plugin import read_custom, convert_hashtags, convert_text_attributes
 
 
 def search_in_file(citation_part: str, contents: str):
@@ -53,38 +55,43 @@ def search_in_file(citation_part: str, contents: str):
 
 
 def mini_ez_links(urlo, base, end, url_whitespace, url_case):
-    base, url_blog = base
+    base, url_blog, md_link_path = base
     url_blog_path = [x for x in url_blog.split('/') if len(x) > 0]
     url_blog_path = url_blog_path[len(url_blog_path) - 1]
-    file_name = urlo[2].replace('index', '')
-    file_name = file_name.replace('../', '')
-    file_name = file_name.replace('./', '')
+    internal_link = Path(md_link_path, urlo[2]).resolve()
+    if os.path.isfile(internal_link):
+        internal_link = str(internal_link).replace(base, '')
+    else:  # fallback to searching
+        file_name = urlo[2].replace('index', '')
+        file_name = file_name.replace('../', '')
+        file_name = file_name.replace('./', '')
 
-    all_docs = [
-        re.sub(rf"(.*)({url_blog_path})?/docs/*", '', x.replace('\\', '/')).replace(
-            '.md', ''
-        )
-        for x in iglob(str(base) + os.sep + '**', recursive=True)
-        if os.path.isfile(x)
-    ]
-    file_found = [
-        '/' + x for x in all_docs if os.path.basename(x) == file_name or x == file_name
-    ]
-    if file_found:
-        file_path = file_found[0].replace(base, '')
-        url = file_path.replace('\\', '/').replace('.md', '')
-        url = url.replace('//', '/')
-        url = url_blog[:-1] + quote(url)
-        if not url.startswith(('https:/', 'http:/')):
-            url = 'https://' + url
-        if not url.endswith('/') and not url.endswith(('png', 'jpg', 'jpeg', 'gif', 'webm')):
-            url = url + '/'
-    else:
-        url = file_name
+        all_docs = [
+            re.sub(rf"(.*)({url_blog_path})?/docs/*", '', x.replace('\\', '/')).replace(
+                '.md', ''
+            )
+            for x in iglob(str(base) + os.sep + '**', recursive=True)
+            if os.path.isfile(x)
+        ]
+        file_found = [
+            '/' + x for x in all_docs if os.path.basename(x) == file_name or x == file_name
+        ]
+        if file_found:
+            internal_link = file_found[0]
+        else:
+            return file_name
+    file_path = internal_link.replace(base, '')
+    url = file_path.replace('\\', '/').replace('.md', '')
+    url = url.replace('//', '/')
+    url = url_blog[:-1] + quote(url)
+    if not url.startswith(('https:/', 'http:/')):
+        url = 'https://' + url
+    if not url.endswith('/') and not url.endswith(('png', 'jpg', 'jpeg', 'gif', 'webm')):
+        url = url + '/'
     return url
 
 
-def cite(md_link_path, link, soup, citation_part, config):
+def cite(md_link_path, link, soup, citation_part, config, callouts, custom_attr):
     """Append the content of the founded file to the original file.
 
     Args:
@@ -97,9 +104,10 @@ def cite(md_link_path, link, soup, citation_part, config):
     """
     docs = config['docs_dir']
     url = config['site_url']
+
     md_config = {
         'mdx_wikilink_plus': {
-            'base_url': (docs, url),
+            'base_url': (docs, url, md_link_path),
             'build_url': mini_ez_links,
             'image_class': 'wikilink',
         }
@@ -115,6 +123,14 @@ def cite(md_link_path, link, soup, citation_part, config):
     contents = frontmatter.loads(text).content
     quote = search_in_file(citation_part, contents)
     if len(quote) > 0:
+        if callouts:
+            quote = CalloutsPlugin().on_page_markdown(quote, None, None, None)
+        if len(custom_attr) > 0:
+            config_attr = {
+                'file': custom_attr,
+                'docs_dir': docs
+            }
+            quote = convert_text_attributes(quote, config_attr)
         html = markdown.markdown(
             quote,
             extensions=[
@@ -132,19 +148,19 @@ def cite(md_link_path, link, soup, citation_part, config):
         link_soup = BeautifulSoup(html, 'html.parser')
         if link_soup:
             tooltip_template = (
-                    "<a href='"
-                    + str(new_uri)
-                    + "' class='link_citation'><i class='fas fa-link'></i> </a> <div"
-                      " class='citation'>"
-                    + str(link_soup).replace(
-                '!<img class="wikilink', '<img class="wikilink'
-            )
-                    + '</div>'
+                "<a href='"
+                + str(new_uri)
+                + "' class='link_citation'><i class='fas fa-link'></i> </a> <div"
+                " class='citation'>"
+                + str(link_soup).replace(
+                    '!<img class="wikilink', '<img class="wikilink'
+                )
+                + '</div>'
             )
     else:
         tooltip_template = (
-                "<div class='not_found'>" +
-                str(link['src'].replace('/', '')) + '</div>'
+            "<div class='not_found'>" +
+            str(link['src'].replace('/', '')) + '</div>'
         )
     new_soup = str(soup).replace(str(link), str(tooltip_template))
     soup = BeautifulSoup(new_soup, 'html.parser')
@@ -170,14 +186,19 @@ def search_doc(md_link_path, all_docs):
         return file[0]
     return 0
 
+
 def create_link(link):
     if link.endswith('/'):
         return link[:-1] + '.md'
     else:
         return link + '.md'
 
+
 class EmbedFile(BasePlugin):
-    config_scheme = (('param', config_options.Type(str, default='')),)
+    config_scheme = (
+        ('callouts', config_options.Type(str|bool, default='false')),
+        ('custom-attributes', config_options.Type(str, default=''))
+    )
 
     def __init__(self):
         self.enabled = True
@@ -187,11 +208,9 @@ def on_post_page(self, output_content, page, config):
         soup = BeautifulSoup(output_content, 'html.parser')
         docs = Path(config['docs_dir'])
         md_link_path = ''
-        all_docs = [
-            x
-            for x in iglob(str(docs) + os.sep + '**', recursive=True)
-            if x.endswith('.md')
-        ]
+        callout = self.config['callouts']
+        if isinstance(callout, str):
+            callout = ast.literal_eval(callout.title())
 
         for link in soup.findAll(
                 'img',
@@ -200,19 +219,19 @@ def on_post_page(self, output_content, page, config):
         ):
             if len(link['src']) > 0:
 
-                if link['src'][0] == '.': #relative links
-                    md_src=create_link(unquote(link['src']))
-                    md_link_path=Path(
+                if link['src'][0] == '.':  # relative links
+                    md_src = create_link(unquote(link['src']))
+                    md_link_path = Path(
                         os.path.dirname(page.file.abs_src_path), md_src).resolve()
 
                 elif link['src'][0] == '/':
-                    md_src_path=create_link(unquote(link['src']))
+                    md_src_path = create_link(unquote(link['src']))
                     md_link_path = os.path.join(
                         config['docs_dir'], md_src_path)
                     md_link_path = Path(unquote(md_link_path)).resolve()
 
                 elif link['src'][0] != '#':
-                    md_src_path=create_link(unquote(link['src']))
+                    md_src_path = create_link(unquote(link['src']))
 
                     md_link_path = os.path.join(
                         os.path.dirname(page.file.abs_src_path), md_src_path
@@ -240,10 +259,15 @@ def on_post_page(self, output_content, page, config):
                     md_link_path = Path(md_link_path)
                     if os.path.isfile(md_link_path):
                         soup = cite(md_link_path, link, soup,
-                                    citation_part, config)
+                                    citation_part, config, callout, self.config['custom-attributes'])
                     else:
+                        all_docs = [
+                            x
+                            for x in iglob(str(docs) + os.sep + '**', recursive=True)
+                            if x.endswith('.md')
+                        ]
                         link_found = search_doc(md_link_path, all_docs)
                         if link_found != 0:
                             soup = cite(link_found, link, soup,
-                                        citation_part, config)
+                                        citation_part, config, callout, self.config['custom-attributes'])
         return str(soup)

requirements.txt

@@ -4,3 +4,5 @@ Markdown
 beautifulsoup4
 python-frontmatter
 mdx-wikilink-plus
+mkdocs-callouts
+mkdocs-custom-tags-attributes