mkdocs-nodegraph 0.4.0__tar.gz → 0.5.0__tar.gz

{mkdocs_nodegraph-0.4.0 → mkdocs_nodegraph-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: mkdocs-nodegraph
-Version: 0.4.0
+Version: 0.5.0
 Summary: Node Graph plugin for Mkdocs Material
 Home-page: https://yonge123.github.io/mkdocs-nodegraph/nodegraph.html
 Author: JeongYong Hwang
@@ -18,6 +18,17 @@ Requires-Dist: pyembed-markdown>=1.1.0
 Requires-Dist: mkdocs-glightbox>=0.4.0
 Requires-Dist: pyvis>=0.3.0
 Requires-Dist: PyYAML>=6.0.2
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # mkdocs-nodegraph
 
@@ -35,11 +46,11 @@ It allows you to create interactive visualizations of your documentation structu
 
 <p align="center">
 <a>
-<img alt="example_image_001.png" src="https://github.com/yonge123/mkdocs-nodegraph/blob/master/sources/example_image_001.png?raw=true" data-hpc="true" class="Box-sc-g0xbh4-0 fzFXnm">
+<img alt="example_image_002.png" src="https://github.com/yonge123/mkdocs-nodegraph/blob/master/sources/example_image_002.png?raw=true" data-hpc="true" class="Box-sc-g0xbh4-0 fzFXnm">
 </a>
 
 
-<!-- ![Example Network Graph Visualization](./sources/example_image_001.png) -->
+<!-- ![Example Network Graph Visualization](./sources/example_image_002.png) -->
 
 
 <br>
@@ -106,6 +117,19 @@ mdfile_site -> A website URL that opens on click while holding the Alt key
 
 <br>
 
+## Click Node
+
+`LMB` -> Open Node Page
+
+`Ctrl + LMB` -> Open Node Page in a New Tab
+
+`Alt + LMB` -> Open the mdfile_site Page from the metadata
+
+
+<br>
+
+
+
 ## mkdocs.yml Configuration
 
 

{mkdocs_nodegraph-0.4.0 → mkdocs_nodegraph-0.5.0}/README.md

@@ -14,11 +14,11 @@ It allows you to create interactive visualizations of your documentation structu
 
 <p align="center">
 <a>
-<img alt="example_image_001.png" src="https://github.com/yonge123/mkdocs-nodegraph/blob/master/sources/example_image_001.png?raw=true" data-hpc="true" class="Box-sc-g0xbh4-0 fzFXnm">
+<img alt="example_image_002.png" src="https://github.com/yonge123/mkdocs-nodegraph/blob/master/sources/example_image_002.png?raw=true" data-hpc="true" class="Box-sc-g0xbh4-0 fzFXnm">
 </a>
 
 
-<!-- ![Example Network Graph Visualization](./sources/example_image_001.png) -->
+<!-- ![Example Network Graph Visualization](./sources/example_image_002.png) -->
 
 
 <br>
@@ -85,6 +85,19 @@ mdfile_site -> A website URL that opens on click while holding the Alt key
 
 <br>
 
+## Click Node
+
+`LMB` -> Open Node Page
+
+`Ctrl + LMB` -> Open Node Page in a New Tab
+
+`Alt + LMB` -> Open the mdfile_site Page from the metadata
+
+
+<br>
+
+
+
 ## mkdocs.yml Configuration
 
 

{mkdocs_nodegraph-0.4.0 → mkdocs_nodegraph-0.5.0}/mkdocs_nodegraph/__init__.py

@@ -1,3 +1,3 @@
 from mkdocs_nodegraph.plugin import GraphViewPlugin
 
-__version__ = "0.4.0"
+__version__ = "0.4.1"

{mkdocs_nodegraph-0.4.0 → mkdocs_nodegraph-0.5.0}/mkdocs_nodegraph/nodegraph/generate_graph.py

@@ -131,7 +131,7 @@ class GraphBuilder():
 
         # self.net.show_buttons(filter_=['physics', 'nodes', 'links'])
     # build graph from parsed markdown pages
-    def build(self, mdfiles):
+    def build(self, mdfiles, tags=None):
         nx_graph = nx.Graph()
         edget_info_dic = dict()
         color_list = copy.deepcopy(beautifulcolors)
@@ -195,6 +195,7 @@ class GraphBuilder():
                             label=mdfile.title, 
                             url=html, 
                             url2=alt_click_url,
+                            nodetype="filenode",
                             size=size, 
                             shape=shape, 
                             image=icon, 
@@ -212,6 +213,40 @@ class GraphBuilder():
                     edge_len = max_link * 45 + ( idx * 35)
                     nx_graph.add_edge(mdfile.uid, link_uid, length=edge_len)
 
+        if tags:
+            for idx, tag in enumerate(tags):
+                tag_name = tag["name"]
+                tag_uid = tag["uid"]
+                link_uids = tag["link_uids"]
+                count_links = len(link_uids)
+                icon = ""
+                shape="dot"
+                alt_click_url = ""
+                tag_color = "#FFD415"
+                size = 50 + (count_links * 4)
+                if size > 120:
+                    size = 120
+                nx_graph.add_node(tag_uid, 
+                                label=tag_name, 
+                                url="", 
+                                url2=alt_click_url, 
+                                nodetype="tagnode", 
+                                size=size, 
+                                shape=shape, 
+                                image=icon, 
+                                color=tag_color, 
+                                opacity=1, 
+                                borderWidth=2, 
+                                )
+            
+                edge_len = count_links * 45 + ( idx * 35)
+                if link_uids:
+                    for link_uid in link_uids:
+                        nx_graph.add_edge(tag_uid, 
+                                          link_uid, 
+                                          length=edge_len
+                                          )
+
         # self.net.from_nx(nx_graph) 
         self.net.from_nx(nx_graph, 
                          default_node_size=50, 
@@ -247,7 +282,8 @@ def load_pyvis_opts(file_path):
         return fout.read()
 
 
-def build_graph(docs_dir, site_dir, output_file, pyvis_opts_file, graph_opts_file, config_graphfile):
+def build_graph(docs_dir, site_dir, output_file, pyvis_opts_file, 
+                graph_opts_file, config_graphfile):
     if not os.path.isfile(pyvis_opts_file):
         raise IOError(f'Failed to find file -> "{pyvis_opts_file}"')
 
@@ -258,14 +294,16 @@ def build_graph(docs_dir, site_dir, output_file, pyvis_opts_file, graph_opts_fil
     os.makedirs(outputDir, exist_ok=True)
 
     parser = MdParser(docs_dir)
-    mdfiles = parser.parse()
-
+    parser.parse()
+    mdfiles = parser.mdfiles
+    tags = parser.tags
+    
     graph_config = read_config(graph_opts_file)
     graph_opts = load_graph_opts(graph_config)
     pyvis_opts = load_pyvis_opts(pyvis_opts_file)
     
     builder = GraphBuilder(pyvis_opts, graph_opts, output_file, config_graphfile, docs_dir, site_dir)
-    builder.build(mdfiles)
+    builder.build(mdfiles, tags)
 
 
 def rebuild_graph_html(index_path, graph_path, output_path=None):

{mkdocs_nodegraph-0.4.0 → mkdocs_nodegraph-0.5.0}/mkdocs_nodegraph/nodegraph/graph_opts.json

@@ -1,7 +1,7 @@
 {
     "width": "100%",
-    "height": "1400px",
+    "height": "90vh",
     "heading": "",
-    "bgcolor": "#222222",
+    "bgcolor": "191B20",
     "font_color": "#94A3B8"
 }

{mkdocs_nodegraph-0.4.0 → mkdocs_nodegraph-0.5.0}/mkdocs_nodegraph/nodegraph/mdparser.py

@@ -52,6 +52,7 @@ class MdParser():
 
     def __init__(self, target_dir):
         self.mdfiles = []
+        self.tags = []
         self.target_dir = target_dir
 
     def parse_md(self, file_name):
@@ -61,8 +62,9 @@ class MdParser():
         title = ""
         metadata = ""
         return MdFile(file_name, base_name, title, links, link_uids, metadata)
-
+    
     def parse(self):
+        tags_dic = dict()
         uid = 1
         for subdir, dirs, files in os.walk(self.target_dir):
             for f in files:
@@ -71,14 +73,20 @@ class MdParser():
 
                     if not any(x for x in self.mdfiles if x.file_path == path):
                         md = self.parse_md(path)
+                        md.uid = uid
+                        self.mdfiles.append(md)
+
                         parseMedata = getMetadata(path)
                         if parseMedata:
                             metadata = yaml.safe_load(parseMedata)
                             md.metadata = metadata
                             
-                        md.uid = uid
+                            if "tags" in metadata:
+                                for tag in metadata["tags"]:
+                                    if tag not in tags_dic:
+                                        tags_dic[tag] = set()
+                                    tags_dic[tag].add(uid)
                         uid += 1
-                        self.mdfiles.append(md)
 
         for mdfile in self.mdfiles:
             uids = set()
@@ -86,10 +94,19 @@ class MdParser():
             for link in mdfile.mdlinks:
                 link_basename = os.path.basename(link)
                 link_new = link.replace("../", "/").replace("./", "").replace("/", "").replace(".", "")
-                uid = list(filter(lambda x: (x.file_path.replace("\\", "").replace("../", "/").replace("./", "").replace("/", "").replace(".", "").endswith(link_new) and os.path.basename(x.file_path) == link_basename), self.mdfiles))
-                if len(uid) > 0:
-                    uids.add(uid[0].uid)
-                    
+                getmdfiles = list(filter(lambda x: (x.file_path.replace("\\", "").replace("../", "/").replace("./", "").replace("/", "").replace(".", "").endswith(link_new) and os.path.basename(x.file_path) == link_basename), self.mdfiles))
+                if len(getmdfiles) > 0:
+                    uids.add(getmdfiles[0].uid)
+
             mdfile.link_uids = list(uids)
-            
-        return self.mdfiles
+        
+        if tags_dic:
+            for tag, link_uids in tags_dic.items():
+                self.tags.append({
+                    'name': tag,
+                    'uid': uid,
+                    'link_uids': link_uids
+                })
+                uid += 1
+
+        return self.mdfiles, self.tags