Transform Obsidian-style admonitions into MkDocs Material admonitions automatically.
Project description
Obsidian to Material
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, usando el plugin Admonition, permite escribir bloques como este:
```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, facilitando el copiado directo de contenidos desde Obsidian.
---
## 🚀 Instalación
Instálalo con `pip`:
```bash
pip install obsidian-to-material
Luego, en tu archivo mkdocs.yml, añade:
markdown_extensions:
- admonition
- obsidian_admonitions
- pymdownx.superfences
No necesitas configurar custom_fences ni ningún paso adicional.
🙌 Créditos
Este proyecto está inspirado en el excelente trabajo de Jeremy Valentine, autor del plugin Admonition para Obsidian.md.
📄 Licencia
Distribuido bajo licencia MIT.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file obsidian_to_material-0.1.1.tar.gz.
File metadata
- Download URL: obsidian_to_material-0.1.1.tar.gz
- Upload date:
- Size: 3.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
74bfdd6593e888c48a858d923b1125cb48624c9753ebe0fa8b1d269064f764db
|
|
| MD5 |
9064a4725af1479bea79fae58eb1c97f
|
|
| BLAKE2b-256 |
cf70b1844176785a9c5e091a4dd73a7ee47f9042404e9080cfe7fc90107233b4
|
File details
Details for the file obsidian_to_material-0.1.1-py3-none-any.whl.
File metadata
- Download URL: obsidian_to_material-0.1.1-py3-none-any.whl
- Upload date:
- Size: 4.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8f211a58bcae565d00e06bb997fa6efa9ed50061da59de6d2925e400fb8ffcb1
|
|
| MD5 |
7d684e9b95906a88d526c7a19642cc92
|
|
| BLAKE2b-256 |
63216995e0c414a6cc8e636f97b75aea0c3fab381fc7f7f05c108eb68aa1c62c
|