Metadata-Version: 2.2
Name: mkdocs-obsidian-excalidraw-plugin
Version: 0.1.1
Summary: A MkDocs plugin
Home-page: 
Author: Peter Heiss
Author-email: peter.heiss@uni-muenster.de
License: MIT
Keywords: mkdocs,excalidraw,obsidian
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs>=1.6.1
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: keywords
Dynamic: license
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# mkdocs-obsidian-excalidraw-plugin

This plugin includes excalidraw markdown files into the markdown files, which are created by [obsidian-excalidraw-plugin](https://github.com/zsviczian/obsidian-excalidraw-plugin). It fences it with code-block with `excalidraw`-type. In combination with [mkdocs-kroki-plugin](https://github.com/AVATEAM-IT-SYSTEMHAUS/mkdocs-kroki-plugin) you can include such files automatically into your website.

> **Note:** All excalidraw markdown files has to have the extension `.excalidraw.md`, otherwise the plugin will not find them.

## Setup

Install the plugin using pip:

`pip install mkdocs-obsidian-excalidraw-plugin`

Activate the plugin in `mkdocs.yml`:
```yaml
plugins:
  - search
  - obsidian-excalidraw
```

> **Note:** If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set, but now you have to enable it explicitly.

More information about plugins in the [MkDocs documentation][mkdocs-plugins].

### Template setup for complete obsidian setup

Install the following plugins: (search for them by yourself for more documentation)

- mkdocs-obsidian-bridge
- mkdocs-obsidian-excalidraw-plugin
- mkdocs-obsidian-support-plugin
- mkdocs-kroki-plugin

`pip install mkdocs-obsidian-bridge mkdocs-obsidian-excalidraw-plugin mkdocs-obsidian-support-plugin mkdocs-kroki-plugin`

And set them up like the following

```yaml
plugins:
  - search
  - obsidian-excalidraw:
      FencePrefix: ""
  - obsidian-support
  - obsidian-bridge
  - kroki:
      FencePrefix: ""
      EnableExcalidraw: true
      HttpMethod: POST
      FileTypes:
        - svg
        - png
```

## Config

* `FencePrefix` - Adjust this to your config of kroki. If you do not specify it, it will defaults to `kroki-`. It is does not set correctly, kroki-plugin will not find the code block this plugin included.

## Usage

## See Also

More information about templates [here][mkdocs-template].

More information about blocks [here][mkdocs-block].

[mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/
[mkdocs-template]: https://www.mkdocs.org/user-guide/custom-themes/#template-variables
[mkdocs-block]: https://www.mkdocs.org/user-guide/styling-your-docs/#overriding-template-blocks
