mkdocs-nodegraph 0.2.0__tar.gz → 0.3.0__tar.gz

{mkdocs-nodegraph-0.2.0 → mkdocs_nodegraph-0.3.0}/PKG-INFO

@@ -1,160 +1,173 @@
-Metadata-Version: 2.1
-Name: mkdocs-nodegraph
-Version: 0.2.0
-Summary: Node Graph plugin for Mkdocs Material
-Home-page: https://yonge123.github.io/mkdocs-nodegraph/nodegraph.html
-Author: JeongYong Hwang
-Author-email: yonge123@gmail.com
-License: MIT
-Project-URL: Source, https://github.com/yonge123/mkdocs-nodegraph/tree/master
-Project-URL: Bug Tracker, https://github.com/yonge123/mkdocs-nodegraph/issues
-Project-URL: Documentation, https://github.com/yonge123/mkdocs-nodegraph/tree/master
-Keywords: mkdocs,plugin,nodegraph
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-
-# mkdocs-nodegraph
-
-mkdocs-nodegraph - A Plugin for Visualizing Network Graphs in MkDocs
-
-## Summary
-
-mkdocs-nodegraph is a documents network graph visualization plugin for the mkdocs-material. 
-
-It allows you to create interactive visualizations of your documentation structure, helping users navigate through topics more easily. 
-
-
-## Example
-
-
-<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">
-</a>
-
-
-<!-- ![Example Network Graph Visualization](./sources/example_image_001.png) -->
-
-
-<br>
-
-YouTube Link
-
-- https://www.youtube.com/watch?v=KD1AsW304kc
-
-
-<br>
-
-## Install 
-
-Install with setup.py
-
-```shell
-
-python.exe setup.py install
-
-```
-
-<br>
-
-
-Install with pip
-
-```sh
-pip install mkdocs-nodegraph
-```
-
-<br>
-
-Uninstall with pip
-
-```
-pip uninstall mkdocs-nodegraph
-
-```
-
-
-<br>
-
-## Setup Tags, Node Icon and Color on Markdown File
-
-```md
-
----
-tags:
-  - CG
-  - 3D software
-mdfile_icon: "_sources/svgs/blender.svg"
-mdfile_color: "#ea7600"
----
-
-```
-
-
-<br>
-
-## mkdocs.yml Configuration
-
-
-```yml
-
-theme:
-    # pip install mkdocs-material
-    name: material
-    # name: readthedocs
-    features:
-        # - navigation.tabs
-        - content.code.copy
-    palette:
-      # Palette toggle for dark mode
-      - media: "(prefers-color-scheme: dark)"
-        scheme: slate
-        primary: blue
-        accent: blue
-        toggle:
-          icon: material/brightness-7
-          name: Switch to light mode
-      # Palette toggle for light mode
-      - media: "(prefers-color-scheme: light)"
-        scheme: default
-        primary: blue
-        accent: blue
-        toggle:
-          icon: material/brightness-4
-          name: Switch to dark mode
-
-plugins:
-    - search
-    - offline
-    - glightbox:
-        skip_classes: 
-            - collapse-btn
-    - nodegraph:
-        graphfile: "nodegraph.html"
-
-```
-
-<br>
-
-After setting up the nodegraph plugin with its graphfile path, you can build your site
-
-```shell
-mkdocs build 
-```
-
-<br>
-
-<!-- After building the site, you can click the button ![](./sources/graph_icon.svg) to open the graph file. -->
-
-After building the site, you can click the button <img src="https://github.com/yonge123/mkdocs-nodegraph/raw/master/sources/graph_icon.svg" alt="" style="max-width: 100%;"> to open the graph file.
-
-
-<br>
-
-
-## References
-
-- https://github.com/barrettotte/md-graph?tab=readme-ov-file
-- https://pyvis.readthedocs.io/en/latest/
-
-<br>
+Metadata-Version: 2.1
+Name: mkdocs-nodegraph
+Version: 0.3.0
+Summary: Node Graph plugin for Mkdocs Material
+Home-page: https://yonge123.github.io/mkdocs-nodegraph/nodegraph.html
+Author: JeongYong Hwang
+Author-email: yonge123@gmail.com
+License: MIT
+Project-URL: Source, https://github.com/yonge123/mkdocs-nodegraph/tree/master
+Project-URL: Bug Tracker, https://github.com/yonge123/mkdocs-nodegraph/issues
+Project-URL: Documentation, https://github.com/yonge123/mkdocs-nodegraph/tree/master
+Keywords: mkdocs,plugin,nodegraph
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: mkdocs>=1.4.0
+Requires-Dist: mkdocs-material>=9.5.31
+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
+
+# mkdocs-nodegraph
+
+mkdocs-nodegraph - A Plugin for Visualizing Network Graphs in MkDocs
+
+## Summary
+
+mkdocs-nodegraph is a documents network graph visualization plugin for the mkdocs-material. 
+
+It allows you to create interactive visualizations of your documentation structure, helping users navigate through topics more easily. 
+
+
+## Example
+
+
+<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">
+</a>
+
+
+<!-- ![Example Network Graph Visualization](./sources/example_image_001.png) -->
+
+
+<br>
+
+YouTube Link
+
+- https://www.youtube.com/watch?v=KD1AsW304kc
+
+
+<br>
+
+## Install 
+
+Install with setup.py
+
+```shell
+
+python.exe setup.py install
+
+```
+
+<br>
+
+
+Install with pip
+
+```sh
+pip install mkdocs-nodegraph
+```
+
+<br>
+
+Uninstall with pip
+
+```
+pip uninstall mkdocs-nodegraph
+
+```
+
+
+<br>
+
+## Setup Tags, Node Icon and Color on Markdown File
+
+```md
+
+---
+tags:
+  - CG
+  - 3D software
+mdfile_icon: "_sources/svgs/blender.svg"
+mdfile_color: "#ea7600"
+mdfile_site: "https://www.blender.org/"
+---
+
+```
+
+mdfile_icon -> Node Icon
+
+mdfile_color -> Node Color
+
+mdfile_site -> A website URL that opens on click while holding the Alt key
+
+
+<br>
+
+## mkdocs.yml Configuration
+
+
+```yml
+
+theme:
+    # pip install mkdocs-material
+    name: material
+    # name: readthedocs
+    features:
+        # - navigation.tabs
+        - content.code.copy
+    palette:
+      # Palette toggle for dark mode
+      - media: "(prefers-color-scheme: dark)"
+        scheme: slate
+        primary: blue
+        accent: blue
+        toggle:
+          icon: material/brightness-7
+          name: Switch to light mode
+      # Palette toggle for light mode
+      - media: "(prefers-color-scheme: light)"
+        scheme: default
+        primary: blue
+        accent: blue
+        toggle:
+          icon: material/brightness-4
+          name: Switch to dark mode
+
+plugins:
+    - search
+    - offline
+    - glightbox:
+        skip_classes: 
+            - collapse-btn
+    - nodegraph:
+        graphfile: "nodegraph.html"
+
+```
+
+<br>
+
+After setting up the nodegraph plugin with its graphfile path, you can build your site
+
+```shell
+mkdocs build 
+```
+
+<br>
+
+<!-- After building the site, you can click the button ![](./sources/graph_icon.svg) to open the graph file. -->
+
+After building the site, you can click the button <img src="https://github.com/yonge123/mkdocs-nodegraph/raw/master/sources/graph_icon.svg" alt="" style="max-width: 100%;"> to open the graph file.
+
+
+<br>
+
+
+## References
+
+- https://github.com/barrettotte/md-graph?tab=readme-ov-file
+- https://pyvis.readthedocs.io/en/latest/
+
+<br>

{mkdocs-nodegraph-0.2.0 → mkdocs_nodegraph-0.3.0}/README.md

@@ -1,145 +1,152 @@
-# mkdocs-nodegraph
-
-mkdocs-nodegraph - A Plugin for Visualizing Network Graphs in MkDocs
-
-## Summary
-
-mkdocs-nodegraph is a documents network graph visualization plugin for the mkdocs-material. 
-
-It allows you to create interactive visualizations of your documentation structure, helping users navigate through topics more easily. 
-
-
-## Example
-
-
-<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">
-</a>
-
-
-<!-- ![Example Network Graph Visualization](./sources/example_image_001.png) -->
-
-
-<br>
-
-YouTube Link
-
-- https://www.youtube.com/watch?v=KD1AsW304kc
-
-
-<br>
-
-## Install 
-
-Install with setup.py
-
-```shell
-
-python.exe setup.py install
-
-```
-
-<br>
-
-
-Install with pip
-
-```sh
-pip install mkdocs-nodegraph
-```
-
-<br>
-
-Uninstall with pip
-
-```
-pip uninstall mkdocs-nodegraph
-
-```
-
-
-<br>
-
-## Setup Tags, Node Icon and Color on Markdown File
-
-```md
-
----
-tags:
-  - CG
-  - 3D software
-mdfile_icon: "_sources/svgs/blender.svg"
-mdfile_color: "#ea7600"
----
-
-```
-
-
-<br>
-
-## mkdocs.yml Configuration
-
-
-```yml
-
-theme:
-    # pip install mkdocs-material
-    name: material
-    # name: readthedocs
-    features:
-        # - navigation.tabs
-        - content.code.copy
-    palette:
-      # Palette toggle for dark mode
-      - media: "(prefers-color-scheme: dark)"
-        scheme: slate
-        primary: blue
-        accent: blue
-        toggle:
-          icon: material/brightness-7
-          name: Switch to light mode
-      # Palette toggle for light mode
-      - media: "(prefers-color-scheme: light)"
-        scheme: default
-        primary: blue
-        accent: blue
-        toggle:
-          icon: material/brightness-4
-          name: Switch to dark mode
-
-plugins:
-    - search
-    - offline
-    - glightbox:
-        skip_classes: 
-            - collapse-btn
-    - nodegraph:
-        graphfile: "nodegraph.html"
-
-```
-
-<br>
-
-After setting up the nodegraph plugin with its graphfile path, you can build your site
-
-```shell
-mkdocs build 
-```
-
-<br>
-
-<!-- After building the site, you can click the button ![](./sources/graph_icon.svg) to open the graph file. -->
-
-After building the site, you can click the button <img src="https://github.com/yonge123/mkdocs-nodegraph/raw/master/sources/graph_icon.svg" alt="" style="max-width: 100%;"> to open the graph file.
-
-
-<br>
-
-
-## References
-
-- https://github.com/barrettotte/md-graph?tab=readme-ov-file
-- https://pyvis.readthedocs.io/en/latest/
-
-<br>
+# mkdocs-nodegraph
+
+mkdocs-nodegraph - A Plugin for Visualizing Network Graphs in MkDocs
+
+## Summary
+
+mkdocs-nodegraph is a documents network graph visualization plugin for the mkdocs-material. 
+
+It allows you to create interactive visualizations of your documentation structure, helping users navigate through topics more easily. 
+
+
+## Example
+
+
+<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">
+</a>
+
+
+<!-- ![Example Network Graph Visualization](./sources/example_image_001.png) -->
+
+
+<br>
+
+YouTube Link
+
+- https://www.youtube.com/watch?v=KD1AsW304kc
+
+
+<br>
+
+## Install 
+
+Install with setup.py
+
+```shell
+
+python.exe setup.py install
+
+```
+
+<br>
+
+
+Install with pip
+
+```sh
+pip install mkdocs-nodegraph
+```
+
+<br>
+
+Uninstall with pip
+
+```
+pip uninstall mkdocs-nodegraph
+
+```
+
+
+<br>
+
+## Setup Tags, Node Icon and Color on Markdown File
+
+```md
+
+---
+tags:
+  - CG
+  - 3D software
+mdfile_icon: "_sources/svgs/blender.svg"
+mdfile_color: "#ea7600"
+mdfile_site: "https://www.blender.org/"
+---
+
+```
+
+mdfile_icon -> Node Icon
+
+mdfile_color -> Node Color
+
+mdfile_site -> A website URL that opens on click while holding the Alt key
+
+
+<br>
+
+## mkdocs.yml Configuration
+
+
+```yml
+
+theme:
+    # pip install mkdocs-material
+    name: material
+    # name: readthedocs
+    features:
+        # - navigation.tabs
+        - content.code.copy
+    palette:
+      # Palette toggle for dark mode
+      - media: "(prefers-color-scheme: dark)"
+        scheme: slate
+        primary: blue
+        accent: blue
+        toggle:
+          icon: material/brightness-7
+          name: Switch to light mode
+      # Palette toggle for light mode
+      - media: "(prefers-color-scheme: light)"
+        scheme: default
+        primary: blue
+        accent: blue
+        toggle:
+          icon: material/brightness-4
+          name: Switch to dark mode
+
+plugins:
+    - search
+    - offline
+    - glightbox:
+        skip_classes: 
+            - collapse-btn
+    - nodegraph:
+        graphfile: "nodegraph.html"
+
+```
+
+<br>
+
+After setting up the nodegraph plugin with its graphfile path, you can build your site
+
+```shell
+mkdocs build 
+```
+
+<br>
+
+<!-- After building the site, you can click the button ![](./sources/graph_icon.svg) to open the graph file. -->
+
+After building the site, you can click the button <img src="https://github.com/yonge123/mkdocs-nodegraph/raw/master/sources/graph_icon.svg" alt="" style="max-width: 100%;"> to open the graph file.
+
+
+<br>
+
+
+## References
+
+- https://github.com/barrettotte/md-graph?tab=readme-ov-file
+- https://pyvis.readthedocs.io/en/latest/
+
+<br>

{mkdocs-nodegraph-0.2.0 → mkdocs_nodegraph-0.3.0}/mkdocs_nodegraph/__init__.py

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