mkdocs-obsidian-interactive-graph-plugin 0.1.0__tar.gz

mkdocs-obsidian-interactive-graph-plugin-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 daxcore
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mkdocs-obsidian-interactive-graph-plugin-0.1.0/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.1
+Name: mkdocs-obsidian-interactive-graph-plugin
+Version: 0.1.0
+Summary: A MkDocs plugin that generates a obsidian like interactive graph
+Home-page: https://github.com/daxcore/mkdocs-obsidian-interactive-graph
+Author: daxcore
+Author-email: 300ccda6-8d43-4f23-808e-961e653ff7d6@anonaddy.com
+License: MIT
+Keywords: mkdocs
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mkdocs-material>=9.0.0
+
+# Interactive Graph for Material for MkDocs
+Plugin for Material for MkDocs to draw an interactive graph like Obsidian.
+Just available for non-mobile website yet.
+
+# Installation
+`pip install mkdocs-obsidian-interactive-graph-plugin`
+
+# Usage
+Activate the plugin in mkdocs.yml, but note that this plugin has to be located before plugins, that replace wikilinks to markdown links. Currently just wikilinks like `[[Link]]` are supported.
+```
+plugins:
+  - obsidian-interactive-graph
+```
+
+# Development
+Adapt the `.env` and `mkdocs.yml` files to your needs.
+Build and start the Docker via `docker compose up --build`.
+
+# References
+* https://www.mkdocs.org/
+* https://squidfunk.github.io/mkdocs-material/
+* https://github.com/ndy2/mkdocs-obsidian-support-plugin/tree/main
+* https://github.com/GooRoo/mkdocs-obsidian-bridge
+* https://github.com/blueswen/mkdocs-glightbox
+* https://echarts.apache.org

mkdocs-obsidian-interactive-graph-plugin-0.1.0/README.md

@@ -0,0 +1,25 @@
+# Interactive Graph for Material for MkDocs
+Plugin for Material for MkDocs to draw an interactive graph like Obsidian.
+Just available for non-mobile website yet.
+
+# Installation
+`pip install mkdocs-obsidian-interactive-graph-plugin`
+
+# Usage
+Activate the plugin in mkdocs.yml, but note that this plugin has to be located before plugins, that replace wikilinks to markdown links. Currently just wikilinks like `[[Link]]` are supported.
+```
+plugins:
+  - obsidian-interactive-graph
+```
+
+# Development
+Adapt the `.env` and `mkdocs.yml` files to your needs.
+Build and start the Docker via `docker compose up --build`.
+
+# References
+* https://www.mkdocs.org/
+* https://squidfunk.github.io/mkdocs-material/
+* https://github.com/ndy2/mkdocs-obsidian-support-plugin/tree/main
+* https://github.com/GooRoo/mkdocs-obsidian-bridge
+* https://github.com/blueswen/mkdocs-glightbox
+* https://echarts.apache.org

mkdocs-obsidian-interactive-graph-plugin-0.1.0/mkdocs_obsidian_interactive_graph_plugin.egg-info/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.1
+Name: mkdocs-obsidian-interactive-graph-plugin
+Version: 0.1.0
+Summary: A MkDocs plugin that generates a obsidian like interactive graph
+Home-page: https://github.com/daxcore/mkdocs-obsidian-interactive-graph
+Author: daxcore
+Author-email: 300ccda6-8d43-4f23-808e-961e653ff7d6@anonaddy.com
+License: MIT
+Keywords: mkdocs
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mkdocs-material>=9.0.0
+
+# Interactive Graph for Material for MkDocs
+Plugin for Material for MkDocs to draw an interactive graph like Obsidian.
+Just available for non-mobile website yet.
+
+# Installation
+`pip install mkdocs-obsidian-interactive-graph-plugin`
+
+# Usage
+Activate the plugin in mkdocs.yml, but note that this plugin has to be located before plugins, that replace wikilinks to markdown links. Currently just wikilinks like `[[Link]]` are supported.
+```
+plugins:
+  - obsidian-interactive-graph
+```
+
+# Development
+Adapt the `.env` and `mkdocs.yml` files to your needs.
+Build and start the Docker via `docker compose up --build`.
+
+# References
+* https://www.mkdocs.org/
+* https://squidfunk.github.io/mkdocs-material/
+* https://github.com/ndy2/mkdocs-obsidian-support-plugin/tree/main
+* https://github.com/GooRoo/mkdocs-obsidian-bridge
+* https://github.com/blueswen/mkdocs-glightbox
+* https://echarts.apache.org

mkdocs-obsidian-interactive-graph-plugin-0.1.0/mkdocs_obsidian_interactive_graph_plugin.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+setup.py
+mkdocs_obsidian_interactive_graph_plugin.egg-info/PKG-INFO
+mkdocs_obsidian_interactive_graph_plugin.egg-info/SOURCES.txt
+mkdocs_obsidian_interactive_graph_plugin.egg-info/dependency_links.txt
+mkdocs_obsidian_interactive_graph_plugin.egg-info/entry_points.txt
+mkdocs_obsidian_interactive_graph_plugin.egg-info/requires.txt
+mkdocs_obsidian_interactive_graph_plugin.egg-info/top_level.txt
+obsidian_interactive_graph/__init__.py
+obsidian_interactive_graph/plugin.py

mkdocs-obsidian-interactive-graph-plugin-0.1.0/mkdocs_obsidian_interactive_graph_plugin.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

mkdocs-obsidian-interactive-graph-plugin-0.1.0/mkdocs_obsidian_interactive_graph_plugin.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[mkdocs.plugins]
+obsidian-interactive-graph = obsidian_interactive_graph.plugin:ObsidianInteractiveGraphPlugin

mkdocs-obsidian-interactive-graph-plugin-0.1.0/mkdocs_obsidian_interactive_graph_plugin.egg-info/requires.txt

@@ -0,0 +1 @@
+mkdocs-material>=9.0.0

mkdocs-obsidian-interactive-graph-plugin-0.1.0/mkdocs_obsidian_interactive_graph_plugin.egg-info/top_level.txt

@@ -0,0 +1 @@
+obsidian_interactive_graph

mkdocs-obsidian-interactive-graph-plugin-0.1.0/obsidian_interactive_graph/plugin.py

@@ -0,0 +1,121 @@
+import json
+import os
+import re
+
+from mkdocs.config.defaults import MkDocsConfig
+from mkdocs.plugins import BasePlugin, get_plugin_logger
+from mkdocs.structure.files import Files as MkDocsFiles
+from mkdocs.structure.pages import Page as MkDocsPage
+from mkdocs.structure.nav import Navigation as MkDocsNav
+
+
+class ObsidianInteractiveGraphPlugin(BasePlugin):
+    def __init__(self):
+        super().__init__()
+        self.logger = get_plugin_logger(__name__)
+        self.nodes = {}
+        self.site_path = ""
+        self.current_id = 0
+        self.data = json.loads('{ "nodes": [], "links": [] }')
+
+    @property
+    def id(self):
+        current_id = self.current_id
+        self.current_id += 1
+        return current_id
+
+    def get_path(self, base: str, *argv: list[str]) -> str:
+        from urllib.parse import urljoin
+        result = base
+        for path in argv:
+            result = urljoin(result, path)
+        return result
+
+    def get_page_path(self, page: MkDocsPage) -> str:
+        return self.get_path(self.site_path, page.file.src_uri).strip(".md")
+
+    def page_if_exists(self, page: str) -> str:
+        page = self.get_path(self.site_path, page)
+        for k,_ in self.nodes.items():
+            if k == page:
+                return page
+        return None
+
+    def collect_pages(self, nav: MkDocsNav, config: MkDocsConfig):
+        for page in nav.pages:
+            page.read_source(config=config)
+            self.nodes[self.get_page_path(page)] = {
+                "id": self.id,
+                "title": page.title,
+                "url": page.abs_url,
+                "symbolSize": 0,
+                "markdown": page.markdown,
+                "is_index": page.is_index
+            }
+
+    def parse_markdown(self, markdown: str, page: MkDocsPage):
+        # wikilinks: [[Link#Anchor|Custom Text]], just the link is needed
+        WIKI_PATTERN = re.compile(r"(?<!\!)\[\[(?P<wikilink>[^\|^\]^\#]{1,})(?:.*)\]\]")
+        for match in re.finditer(WIKI_PATTERN, markdown):
+            wikilink = match.group('wikilink')
+            self.logger.warning(wikilink)
+
+            # get the nodes key
+            page_path = self.get_page_path(page)
+
+            # search page path of target page
+            target_page_path = ""
+
+            # link to self if wikilink is index and current page is index
+            if wikilink == "index" and self.nodes[page_path]["is_index"]:
+                target_page_path = page_path
+            else:
+                # 1st: link to global page if exists
+                # 2nd: search relative
+                wikilink = self.page_if_exists(wikilink) or self.page_if_exists(self.get_path(page_path, wikilink)) or wikilink
+
+                # find something that matches: shortest path depth
+                abslen = None
+                for k,_ in self.nodes.items():
+                    for _ in re.finditer(re.compile(r"(.*" + wikilink + r")"), k):
+                        curlen = k.count('/')
+                        if abslen == None or curlen < abslen:
+                            target_page_path = k
+                            abslen = curlen
+
+            link = {
+                "source": str(self.nodes[page_path]["id"]),
+                "target": str(self.nodes[target_page_path]["id"])
+            }
+            self.data["links"].append(link)
+
+            # rate +1 if page has link of is linked
+            self.nodes[page_path]["symbolSize"] = self.nodes[page_path].get("symbolSize", 1) + 1
+            self.nodes[target_page_path]["symbolSize"] = self.nodes[target_page_path].get("symbolSize", 1) + 1
+
+    def create_graph_json(self, config: MkDocsConfig):
+        for i, (k,v) in enumerate(self.nodes.items()):
+            node = {
+                    "id": str(i),
+                    "name": v["title"],
+                    "symbolSize": v["symbolSize"],
+                    "value": v["url"]
+            }
+            self.data["nodes"].append(node)
+
+        filename = os.path.join(config['site_dir'], 'assets', 'javascripts', 'graph.json')
+        os.makedirs(os.path.dirname(filename), exist_ok=True)
+        with open(filename, 'w') as file:
+            json.dump(self.data, file, sort_keys=False, indent=2)
+
+    def on_config(self, config: MkDocsConfig, **kwargs):
+        self.site_path = config.site_name + "/"
+
+    def on_nav(self, nav: MkDocsNav, files: MkDocsFiles, config: MkDocsConfig, **kwargs):
+        self.collect_pages(nav, config)
+
+    def on_page_markdown(self, markdown: str, page: MkDocsPage, config: MkDocsConfig, files: MkDocsFiles, **kwargs):
+        self.parse_markdown(markdown, page)
+
+    def on_env(self, env, config: MkDocsConfig, files: MkDocsFiles):
+        self.create_graph_json(config)

mkdocs-obsidian-interactive-graph-plugin-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

mkdocs-obsidian-interactive-graph-plugin-0.1.0/setup.py

@@ -0,0 +1,44 @@
+import os
+
+from setuptools import setup, find_packages
+
+VERSION_NUMBER = '0.1.0'
+
+def read_file(fname):
+    return open(os.path.join(os.path.dirname(__file__), fname)).read()
+
+setup(
+    name='mkdocs-obsidian-interactive-graph-plugin',
+    version=VERSION_NUMBER,
+    description='A MkDocs plugin that generates a obsidian like interactive graph',
+    long_description=read_file('README.md'),
+    long_description_content_type='text/markdown',
+    keywords='mkdocs',
+    url='https://github.com/daxcore/mkdocs-obsidian-interactive-graph',
+    author='daxcore',
+    author_email='300ccda6-8d43-4f23-808e-961e653ff7d6@anonaddy.com',
+    license='MIT',
+    python_requires='>=3.6',
+    install_requires=[
+        'mkdocs-material>=9.0.0'
+    ],
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'Intended Audience :: Information Technology',
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Programming Language :: Python :: 3.12'
+    ],
+    packages=find_packages(),
+    entry_points={
+        'mkdocs.plugins': [
+            'obsidian-interactive-graph = obsidian_interactive_graph.plugin:ObsidianInteractiveGraphPlugin'
+        ]
+    }
+)