Metadata-Version: 2.4
Name: mkdocs-note
Version: 0.0.1
Summary: A MkDocs plugin to add note boxes to your documentation.
Home-page: https://github.com/virtualguard101/mkdocs-note
Author: Author Name
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: babel==2.17.0
Requires-Dist: backrefs==5.8
Requires-Dist: beautifulsoup4==4.13.4
Requires-Dist: build==1.3.0
Requires-Dist: cachecontrol==0.14.0
Requires-Dist: cairocffi==1.7.1
Requires-Dist: cairosvg==2.8.2
Requires-Dist: certifi==2025.4.26
Requires-Dist: cffi==1.17.1
Requires-Dist: charset-normalizer==3.4.2
Requires-Dist: click==8.2.1
Requires-Dist: colorama==0.4.6
Requires-Dist: colorlog==6.9.0
Requires-Dist: coverage==7.10.6
Requires-Dist: csscompressor==0.9.5
Requires-Dist: cssselect2==0.8.0
Requires-Dist: defusedxml==0.7.1
Requires-Dist: filelock==3.15.4
Requires-Dist: frontmatter==3.0.8
Requires-Dist: ghp-import==2.1.0
Requires-Dist: gitdb==4.0.10
Requires-Dist: gitpython==3.1.44
Requires-Dist: griffe==1.9.0
Requires-Dist: htmlmin2==0.1.13
Requires-Dist: idna==3.10
Requires-Dist: iniconfig==2.1.0
Requires-Dist: jieba==0.42.1
Requires-Dist: jinja2==3.1.6
Requires-Dist: jsmin==3.0.1
Requires-Dist: lxml==6.0.0
Requires-Dist: markdown==3.8
Requires-Dist: markdown-callouts==0.4.0
Requires-Dist: markupsafe==3.0.2
Requires-Dist: mergedeep==1.3.4
Requires-Dist: mkdocs==1.6.1
Requires-Dist: mkdocs-autorefs==1.4.2
Requires-Dist: mkdocs-drawio==1.11.2
Requires-Dist: mkdocs-get-deps==0.2.0
Requires-Dist: mkdocs-git-revision-date-localized-plugin==1.4.7
Requires-Dist: mkdocs-material==9.6.14
Requires-Dist: mkdocs-material-extensions==1.3.1
Requires-Dist: mkdocs-minify-plugin==0.7.1
Requires-Dist: mkdocs-obsidian-interactive-graph-plugin==0.3.0
Requires-Dist: mkdocs-redirects==1.2.1
Requires-Dist: mkdocs-rss-plugin==1.17.3
Requires-Dist: mkdocstrings==0.30.0
Requires-Dist: mkdocstrings-python==1.16.12
Requires-Dist: msgpack==1.0.8
Requires-Dist: packaging==25.0
Requires-Dist: paginate==0.5.7
Requires-Dist: pathspec==0.12.1
Requires-Dist: pillow==10.4.0
Requires-Dist: platformdirs==4.3.8
Requires-Dist: pluggy==1.6.0
Requires-Dist: pycparser==2.22
Requires-Dist: pygments==2.19.1
Requires-Dist: pymdown-extensions==10.15
Requires-Dist: pypinyin==0.51.0
Requires-Dist: pyproject-hooks==1.2.0
Requires-Dist: pytest==8.4.2
Requires-Dist: pytest-cov==6.2.1
Requires-Dist: python-dateutil==2.9.0.post0
Requires-Dist: pytz==2025.2
Requires-Dist: pyyaml==5.1
Requires-Dist: pyyaml-env-tag==1.1
Requires-Dist: regex==2024.11.6
Requires-Dist: requests==2.32.3
Requires-Dist: sgmllib3k==1.0.0
Requires-Dist: six==1.17.0
Requires-Dist: smmap==5.0.0
Requires-Dist: soupsieve==2.7
Requires-Dist: tinify==1.6.0
Requires-Dist: tinycss2==1.4.0
Requires-Dist: typing-extensions==4.14.1
Requires-Dist: tzdata==2024.1
Requires-Dist: urllib3==2.4.0
Requires-Dist: watchdog==6.0.0
Requires-Dist: webencodings==0.5.1
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

<!-- [![PyPI version](https://badge.fury.io/py/mkdocs-note.svg)](https://badge.fury.io/py/mkdocs-note) -->

`MkDocs-Note` is a plugin for `MkDocs` that transforms your documentation site into a powerful personal knowledge base with bi-directional linking, similar to Obsidian or Roam Research.

## Features

- **Bi-directional Linking**: Automatically create and display backlinks for your notes.
- **Note Management**: Easily create new notes from templates using command line tools.
- **Recent Notes**: Display a list of recent notes on your homepage.
- **Attachment Management**: Handles attachments within your notes directory.
- **Flexible Configuration**: Highly customizable to fit your workflow.

## Installation

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

```
uv venv
uv pip insatll mkdocs-note
```

Or install the plugin using `pip`:

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

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

```yaml
plugins:
  - mkdocs-note
```

## Usage

### Creating Notes

You can create a new note using the following command:

```bash
mkdocs note new "My New Note"
```

### Linking Notes

Use `[[wiki-style]]` links to connect your notes. The plugin will automatically convert these into valid Markdown links and generate backlinks.

`[[My Target Note]]` will be converted to a link to `My Target Note.md`.

### Backlinks

Backlinks are automatically added to the bottom of each note, showing you which other notes link to the current one.

## Configuration

You can customize the plugin's behavior in your `mkdocs.yml`:

```yaml
plugins:
  - note:
      # Whether the plugin is enabled
      enabled: true
      # The root path for your notes
      notes_root_path: ["notes", "docs"]
      # Template for new notes
      notes_template: "templates/default.md"
      # Path for attachments
      attachment_path: "assets"
      # Paths to exclude from note processing
      path_blacklist: ["drafts"]
```

## 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).
