Metadata-Version: 2.4
Name: mkdocs-note
Version: 1.1.0
Summary: A MkDocs plugin to add note boxes to your documentation.
Home-page: https://github.com/virtualguard101/mkdocs-note
Author: virtualguard101
Author-email: virtualguard101 <virtualguard101@gmail.com>
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://github.com/virtualguard101/mkdocs-note
Project-URL: Issues, https://github.com/virtualguard101/mkdocs-note/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs>=1.6.1
Requires-Dist: colorlog>=6.9.0
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest-cov; extra == "test"
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# MkDocs-Note

<div align="center">
  <a href="README.md">English</a> | <a href="README.zh-CN.md">简体中文</a>
</div>

Plugin Usage Demo: [Notebook | virtualguard101's Wiki](https://wiki.virtualguard101.com/notes/){target="_blank"}

`MkDocs-Note` is a plugin for `MkDocs` that automatically manages notes in your documentation site. It's designed to work seamlessly with [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme to create a unified note-taking and documentation experience.

## Features

- **Recent Notes Display**: Automatically displays a list of recent notes on your notes index page

- **Multi-format Support**: Supports both Markdown (.md) and Jupyter Notebook (.ipynb) files

- **Smart Filtering**: Excludes index files and other specified patterns from the recent notes list

- **Flexible Configuration**: Highly customizable note directory, file patterns, and display options

- **Automatic Updates**: Notes list updates automatically when you build your documentation

- **Command Line Interface**: Built-in CLI commands for note management (`mkdocs note init`, `mkdocs note new`, etc.)

- **Asset Management**: Automatic asset directory creation and management for each note

- **Template System**: Configurable note templates with variable substitution

- **Structure Validation**: Ensures compliant asset tree structure for consistent organization

## Installation

Recommended to use [uv](https://docs.astral.sh/uv/) to manage python virtual environment:

```
uv venv
uv pip install mkdocs-note
```

Or using `pip`:

```bash
pip install mkdocs-note
```

Then, add the plugin to your `mkdocs.yml`:

```yaml
plugins:
  - mkdocs-note:
      enabled: true
      notes_dir: "docs/notes"
      index_file: "docs/notes/index.md"
      max_notes: 10
      start_marker: "<!-- recent_notes_start -->"
      end_marker: "<!-- recent_notes_end -->"
```

> **⚠️ Important**: Note the indentation! Use **spaces** (not dashes `-`) for plugin options. The configuration must be a dictionary, not a list. See [Troubleshooting Guide](TROUBLESHOOTING.md) for common configuration issues.

## Usage

### Setting Up Your Notes Directory

#### Option 1: Using Command Line Interface (Recommended)

1. Initialize the notes directory structure:
```bash
mkdocs-note init
```

2. Create a new note:
```bash
mkdocs-note new docs/notes/my-new-note.md
```

#### Option 2: Manual Setup

1. Create a notes directory in your documentation (e.g., `docs/notes/`)

2. Create an `index.md` file in your notes directory

3. Add the marker comments to your index file:

```markdown
# My Notes

<!-- recent_notes_start -->
<!-- recent_notes_end -->
```

### Command Line Interface

The plugin provides several CLI commands for note management:

#### Initialize Notes Directory
```bash
mkdocs-note init [--path PATH]
```
- Creates the notes directory structure

- Analyzes existing asset structures

- Fixes non-compliant asset trees

- Creates an index file with proper markers

#### Create New Note
```bash
mkdocs-note new FILE_PATH [--template TEMPLATE_PATH]
```
- Creates a new note file with template content

- Creates the corresponding asset directory

- Validates asset tree structure compliance

#### Validate Structure
```bash
mkdocs-note validate [--path PATH]
```
- Checks if the asset tree structure complies with the plugin's design

- Reports any structural issues

#### Template Management
```bash
mkdocs-note template [--check] [--create]
```
- Check if the configured template file exists

- Create the template file if it doesn't exist

### Configuration Options

The plugin supports the following configuration options in your `mkdocs.yml`:

| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `enabled` | bool | `true` | Enable or disable the plugin |
| `notes_dir` | Path | `"docs/notes"` | Directory containing your notes |
| `index_file` | Path | `"docs/notes/index.md"` | Index file where recent notes will be displayed |
| `max_notes` | int | `11` | Maximum number of recent notes to display (including index page, but display not including the index page itself) |
| `start_marker` | str | `"<!-- recent_notes_start -->"` | Start marker for notes insertion |
| `end_marker` | str | `"<!-- recent_notes_end -->"` | End marker for notes insertion |
| `supported_extensions` | Set[str] | `{".md", ".ipynb"}` | File extensions to include as notes |
| `exclude_patterns` | Set[str] | `{"index.md", "README.md"}` | File patterns to exclude |
| `exclude_dirs` | Set[str] | `{"__pycache__", ".git", "node_modules"}` | Directories to exclude |
| `use_git_timestamps` | bool | `true` | Use Git commit timestamps for sorting instead of file system timestamps |
| `assets_dir` | Path | `"docs/notes/assets"` | Directory for storing note assets |
| `notes_template` | Path | `"docs/notes/template/default.md"` | Template file for new notes |
| `cache_size` | int | `256` | Size of the cache for performance optimization |

### Template System

The plugin supports a flexible template system for creating new notes:

#### Template Variables

- `{{title}}`: The note title (derived from filename, formatted)

- `{{date}}`: Current date and time

- `{{note_name}}`: The original note filename

#### Default Template

The default template (`docs/notes/template/default.md`) contains:

```markdown
# {{title}}

Created on {{date}}

Note: {{note_name}}
```

#### Custom Templates

You can use custom templates when creating notes:

```bash
mkdocs-note new docs/notes/my-note.md --template path/to/custom-template.md
```

### Asset Management

The plugin automatically manages assets for each note:

- Each note gets a corresponding asset directory: `docs/notes/assets/note-name/`

- Assets are automatically linked and processed during build

- Supports image references and other media files

- Ensures consistent asset organization across all notes

### How It Works

1. The plugin scans your configured notes directory for supported file types

2. It extracts metadata (title, modification date) from each note file

3. Notes are sorted by modification time (most recent first)

   - By default, uses Git commit timestamps for consistent sorting across deployment environments

   - Falls back to file system timestamps if Git is not available

4. The specified number of recent notes is inserted into your index page between the marker comments

5. Asset paths are automatically processed and updated for proper linking

6. The process runs automatically every time you build your documentation

### Sorting Behavior

The plugin uses Git commit timestamps by default (`use_git_timestamps: true`) to ensure consistent sorting across different deployment environments. This is especially important when deploying to platforms like Vercel, Netlify, or GitHub Pages, where file system timestamps may be reset during the build process.

If Git is not available or you prefer to use file system timestamps, you can disable this feature:

```yaml
plugins:
  - mkdocs-note:
      use_git_timestamps: false
```

## Contributing

Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines.

## License

This project is licensed under the [GNU General Public License v3.0](LICENSE).
