obsidian-to-material 0.1.2

Transform Obsidian-style admonitions into MkDocs Material admonitions automatically.

Obsidian to Material

🇪🇸 Español

Obsidian to Material es una extensión para MkDocs que transforma automáticamente los bloques tipo admonition utilizados en Obsidian.md (específicamente los del plugin Admonition de Jeremy Valentine) en bloques compatibles con el tema Material for MkDocs.

Esto permite reutilizar notas personales escritas en Obsidian directamente en sitios estáticos generados con MkDocs, sin necesidad de scripts intermedios ni cambios manuales.

🧩 ¿Por qué?

Obsidian permite escribir bloques como:

```ad-warning
title: ¡Cuidado!
Este es un mensaje importante.
```

Pero MkDocs Material requiere el formato:

!!! warning "¡Cuidado!"
Este es un mensaje importante.

Esta extensión convierte automáticamente los bloques ad-* en su equivalente !!! durante el proceso de construcción del sitio.

🚀 Instalación

pip install obsidian-to-material

Y en mkdocs.yml:

markdown_extensions:
  - admonition
  - obsidian_admonitions
  - pymdownx.superfences

🙌 Créditos

Este proyecto está inspirado en el excelente trabajo de Jeremy Valentine, autor del plugin Admonition para Obsidian.md.

---

🇬🇧 English

Obsidian to Material is a MkDocs extension that automatically transforms admonition-style blocks used in Obsidian.md (specifically via the plugin Admonition by Jeremy Valentine) into blocks compatible with Material for MkDocs.

This allows you to reuse notes written in Obsidian directly inside MkDocs documentation, with no manual conversion or intermediate scripts.

🧩 Why?

With Obsidian and its Admonition plugin, you can write:

```ad-warning
title: Warning!
This is an important message.
```

But MkDocs Material expects:

!!! warning "Warning!"
This is an important message.

This extension converts ad-* blocks to proper !!! admonitions during the Markdown processing phase.

🚀 Installation

pip install obsidian-to-material

In your mkdocs.yml:

markdown_extensions:
  - admonition
  - obsidian_admonitions
  - pymdownx.superfences

🙌 Credits

This project is inspired by the great work of Jeremy Valentine, author of the Admonition plugin for Obsidian.md.

---

📄 License

Distributed under the MIT License.