Merge pull request #62 from virtualguard101/dev

fix: fix 2 issue in plugin module

Author: virtualguard101

MANIFEST.in

@@ -1,3 +1,3 @@
 include LICENSE
 include README.md
-recursive-include src/mkdocs_note/utils/graphps/static *
+recursive-include src/mkdocs_note/static *

docs/about/changelog.md

@@ -1,5 +1,5 @@
 ---
-date: 2025-11-05 00:20:00
+date: 2025-11-05 10:53:00
 title: Changelog
 permalink: 
 publish: true
@@ -12,6 +12,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 3.0.1 - 2025-11-05
+
+### Fixed
+
+- Fixed issue where [recent notes](../usage/recent-notes.md) were not inserted into index page if notes_root was not default value (`docs`).
+
+- Fixed issue that cannot copy static assets to output directory which can make the [graph visualization](../usage/network-graph.md) not working.
+
 ## 3.0.0 - 2025-11-04 (Architecture Simplification)
 
 ### Changed

docs/contributing/contributing.md

@@ -1,5 +1,5 @@
 ---
-date: 2025-10-15 01:06:51
+date: 2025-11-05 11:00:00
 title: Contributing
 permalink: 
 publish: true
@@ -54,13 +54,7 @@ To get started with local development, follow these steps:
 
 4.  **Run Tests**
 
-    To make sure everything is set up correctly, run the test suite:
-
-    ```bash
-    ./tests/test.sh
-    ```
-
-    Or use `pytest` directly:
+    To make sure everything is set up correctly, use `pytest` run the test suite:
 
     ```bash
     uv run pytest

docs/references/index.md

@@ -1,10 +1,10 @@
 ---
 date: 2025-10-16 14:25:41
-title: Index
+title: API References
 permalink: 
-publish: true
+publish: false
 ---
 
-# Index
+# API References
 
 Start writing your note content...

docs/usage/installation.md

@@ -59,3 +59,5 @@ Then you can run the tests for installation verification:
 ```bash
 uv run pytest
 ```
+
+More details about development setup, please refer to [Contributing](../contributing/contributing.md#Development-Setup).

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocs-note"
-version = "3.0.0"
+version = "3.0.1"
 description = "A MkDocs plugin to add note boxes to your documentation."
 readme = "README.md"
 requires-python = ">=3.12"

src/mkdocs_note/plugin.py

@@ -172,9 +172,27 @@ def is_note_index_page(self, f: File) -> bool:
 		Returns:
 			bool: True if the page is a note index page, False otherwise.
 		"""
-		# src_uri is relative to docs_dir, so we just check for 'index.md'
-		# when notes_root is the docs_dir itself
-		return f.src_uri == "index.md"
+		from pathlib import Path
+
+		# Check if file ends with index.md
+		if not f.src_uri.endswith("index.md"):
+			return False
+
+		# Check if file is the index.md directly under notes_root
+		try:
+			notes_dir = (
+				Path(self.config.notes_root)
+				if isinstance(self.config.notes_root, str)
+				else self.config.notes_root
+			)
+			file_path = Path(f.abs_src_path)
+			# Get the relative path from notes_root to the file
+			rel_path = file_path.relative_to(notes_dir)
+			# If the relative path is exactly "index.md", it's the index page
+			return str(rel_path) == "index.md"
+		except (ValueError, AttributeError):
+			# File is not within notes_root
+			return False
 
 
 def insert_recent_note_links(
@@ -204,4 +222,5 @@ def insert_recent_note_links(
 		# No indentation to avoid Markdown treating it as code block
 		content += f'<li><div style="display:flex; justify-content:space-between; align-items:center;"><a href="{url}">{title}</a><span style="font-size:0.8em; color:#888;">{date}</span></div></li>\n'
 	content += "</ul>\n"
+	log.info(f"Insert {insert_num} recent notes into index page")
 	return markdown.replace(replace_marker, content)

tests/test_plugin.py

@@ -41,19 +41,55 @@ def test_config_default_values(self):
 
 	def test_is_note_index_page(self):
 		"""Test is_note_index_page method."""
-		# Create a mock file
-		mock_file = Mock()
-		# src_uri is relative to docs_dir, so 'index.md' not 'docs/index.md'
-		mock_file.src_uri = "index.md"
-
-		# Test with default notes_root
-		result = self.plugin.is_note_index_page(mock_file)
-		self.assertTrue(result)
-
-		# Test with non-index file
-		mock_file.src_uri = "some-other-page.md"
-		result = self.plugin.is_note_index_page(mock_file)
-		self.assertFalse(result)
+		import tempfile
+		import os
+
+		# Create a temporary directory structure
+		with tempfile.TemporaryDirectory() as temp_dir:
+			# Create notes_root directory
+			notes_root = os.path.join(temp_dir, "docs")
+			os.makedirs(notes_root, exist_ok=True)
+
+			# Create index.md in notes_root
+			index_file = os.path.join(notes_root, "index.md")
+			with open(index_file, "w") as f:
+				f.write("# Index")
+
+			# Create a non-index file
+			other_file = os.path.join(notes_root, "some-other-page.md")
+			with open(other_file, "w") as f:
+				f.write("# Other Page")
+
+			# Create a subdirectory with its own index.md
+			sub_dir = os.path.join(notes_root, "subdir")
+			os.makedirs(sub_dir, exist_ok=True)
+			sub_index_file = os.path.join(sub_dir, "index.md")
+			with open(sub_index_file, "w") as f:
+				f.write("# Sub Index")
+
+			# Set notes_root in config
+			self.plugin.config.notes_root = notes_root
+
+			# Test 1: index.md directly under notes_root should return True
+			mock_file = Mock()
+			mock_file.src_uri = "index.md"
+			mock_file.abs_src_path = index_file
+			result = self.plugin.is_note_index_page(mock_file)
+			self.assertTrue(result, "index.md directly under notes_root should be True")
+
+			# Test 2: non-index file should return False
+			mock_file = Mock()
+			mock_file.src_uri = "some-other-page.md"
+			mock_file.abs_src_path = other_file
+			result = self.plugin.is_note_index_page(mock_file)
+			self.assertFalse(result, "Non-index file should be False")
+
+			# Test 3: index.md in subdirectory should return False
+			mock_file = Mock()
+			mock_file.src_uri = "subdir/index.md"
+			mock_file.abs_src_path = sub_index_file
+			result = self.plugin.is_note_index_page(mock_file)
+			self.assertFalse(result, "index.md in subdirectory should be False")
 
 	def test_on_files(self):
 		"""Test on_files event handler."""